completed documentation and fixed a few typos while reviewing

This commit is contained in:
Tony Roy 2021-03-13 09:56:03 -04:00
commit a546d49221
4 changed files with 589 additions and 14 deletions

583
README.md
View file

@ -4,7 +4,7 @@ NetBox is an open source web application designed to help manage and document co
### Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Tests](#tests)
- [Models](#models)
### Installation
Install this package with composer:
```
@ -87,6 +87,585 @@ public function getIndex(NetBox $netBox)
//
}
```
### Models
#### Global
```php
NetBox::status()->show(array $params)
```
- - -
#### Circuits
```php
NetBox::circuits()->list(array $params)
NetBox::circuits()->add(array $params)
NetBox::circuits()->delete(int $id, array $params)
NetBox::circuits()->edit(int $id, array $params)
NetBox::circuits()->show(int $id, array $params)
```
```php
NetBox::providers()->list(array $params)
NetBox::providers()->add(array $params)
NetBox::providers()->delete(int $id, array $params)
NetBox::providers()->edit(int $id, array $params)
NetBox::providers()->show(int $id, array $params)
```
```php
NetBox::circuitTerminations()->list(array $params)
NetBox::circuitTerminations()->add(array $params)
NetBox::circuitTerminations()->delete(int $id, array $params)
NetBox::circuitTerminations()->edit(int $id, array $params)
NetBox::circuitTerminations()->show(int $id, array $params)
```
```php
NetBox::circuitTypes()->list(array $params)
NetBox::circuitTypes()->add(array $params)
NetBox::circuitTypes()->delete(int $id, array $params)
NetBox::circuitTypes()->edit(int $id, array $params)
NetBox::circuitTypes()->show(int $id, array $params)
```
#### DCIM
```php
NetBox::cables()->list(array $params)
NetBox::cables()->add(array $params)
NetBox::cables()->delete(int $id, array $params)
NetBox::cables()->edit(int $id, array $params)
NetBox::cables()->show(int $id, array $params)
```
```php
NetBox::connectedDevices()->list(array $params)
```
```php
NetBox::consoleConnections()->list(array $params)
```
```php
NetBox::consolePorts()->list(array $params)
NetBox::consolePorts()->add(array $params)
NetBox::consolePorts()->delete(int $id, array $params)
NetBox::consolePorts()->edit(int $id, array $params)
NetBox::consolePorts()->show(int $id, array $params)
NetBox::consolePorts()->trace(int $id, array $params)
```
```php
NetBox::consolePortTemplates()->list(array $params)
NetBox::consolePortTemplates()->add(array $params)
NetBox::consolePortTemplates()->delete(int $id, array $params)
NetBox::consolePortTemplates()->edit(int $id, array $params)
NetBox::consolePortTemplates()->show(int $id, array $params)
```
```php
NetBox::consoleServerPorts()->list(array $params)
NetBox::consoleServerPorts()->add(array $params)
NetBox::consoleServerPorts()->delete(int $id, array $params)
NetBox::consoleServerPorts()->edit(int $id, array $params)
NetBox::consoleServerPorts()->show(int $id, array $params)
```
```php
NetBox::consoleServerPortTemplates()->list(array $params)
NetBox::consoleServerPortTemplates()->add(array $params)
NetBox::consoleServerPortTemplates()->delete(int $id, array $params)
NetBox::consoleServerPortTemplates()->edit(int $id, array $params)
NetBox::consoleServerPortTemplates()->show(int $id, array $params)
```
```php
NetBox::deviceBays()->list(array $params)
NetBox::deviceBays()->add(array $params)
NetBox::deviceBays()->delete(int $id, array $params)
NetBox::deviceBays()->edit(int $id, array $params)
NetBox::deviceBays()->show(int $id, array $params)
```
```php
NetBox::deviceBayTemplates()->list(array $params)
NetBox::deviceBayTemplates()->add(array $params)
NetBox::deviceBayTemplates()->delete(int $id, array $params)
NetBox::deviceBayTemplates()->edit(int $id, array $params)
NetBox::deviceBayTemplates()->show(int $id, array $params)
```
```php
NetBox::deviceRoles()->list(array $params)
NetBox::deviceRoles()->add(array $params)
NetBox::deviceRoles()->delete(int $id, array $params)
NetBox::deviceRoles()->edit(int $id, array $params)
NetBox::deviceRoles()->show(int $id, array $params)
```
```php
NetBox::devices()->list(array $params)
NetBox::devices()->add(array $params)
NetBox::devices()->delete(int $id, array $params)
NetBox::devices()->edit(int $id, array $params)
NetBox::devices()->show(int $id, array $params)
NetBox::devices()->napalm(int $id, array $params)
```
```php
NetBox::deviceTypes()->list(array $params)
NetBox::deviceTypes()->add(array $params)
NetBox::deviceTypes()->delete(int $id, array $params)
NetBox::deviceTypes()->edit(int $id, array $params)
NetBox::deviceTypes()->show(int $id, array $params)
```
```php
NetBox::frontPorts()->list(array $params)
NetBox::frontPorts()->add(array $params)
NetBox::frontPorts()->delete(int $id, array $params)
NetBox::frontPorts()->edit(int $id, array $params)
NetBox::frontPorts()->show(int $id, array $params)
NetBox::frontPorts()->paths(int $id, array $params)
```
```php
NetBox::frontPortTemplates()->list(array $params)
NetBox::frontPortTemplates()->add(array $params)
NetBox::frontPortTemplates()->delete(int $id, array $params)
NetBox::frontPortTemplates()->edit(int $id, array $params)
NetBox::frontPortTemplates()->show(int $id, array $params)
```
```php
NetBox::interfaceConnections()->list(array $params)
```
```php
NetBox::interfaces()->list(array $params)
NetBox::interfaces()->add(array $params)
NetBox::interfaces()->delete(int $id, array $params)
NetBox::interfaces()->edit(int $id, array $params)
NetBox::interfaces()->show(int $id, array $params)
NetBox::interfaces()->trace(int $id, array $params)
```
```php
NetBox::interfaceTemplates()->list(array $params)
NetBox::interfaceTemplates()->add(array $params)
NetBox::interfaceTemplates()->delete(int $id, array $params)
NetBox::interfaceTemplates()->edit(int $id, array $params)
NetBox::interfaceTemplates()->show(int $id, array $params)
```
```php
NetBox::inventoryItems()->list(array $params)
NetBox::inventoryItems()->add(array $params)
NetBox::inventoryItems()->delete(int $id, array $params)
NetBox::inventoryItems()->edit(int $id, array $params)
NetBox::inventoryItems()->show(int $id, array $params)
```
```php
NetBox::manufacturers()->list(array $params)
NetBox::manufacturers()->add(array $params)
NetBox::manufacturers()->delete(int $id, array $params)
NetBox::manufacturers()->edit(int $id, array $params)
NetBox::manufacturers()->show(int $id, array $params)
```
```php
NetBox::platforms()->list(array $params)
NetBox::platforms()->add(array $params)
NetBox::platforms()->delete(int $id, array $params)
NetBox::platforms()->edit(int $id, array $params)
NetBox::platforms()->show(int $id, array $params)
```
```php
NetBox::powerFeeds()->list(array $params)
NetBox::powerFeeds()->add(array $params)
NetBox::powerFeeds()->delete(int $id, array $params)
NetBox::powerFeeds()->edit(int $id, array $params)
NetBox::powerFeeds()->show(int $id, array $params)
NetBox::powerFeeds()->trace(int $id, array $params)
```
```php
NetBox::powerOutlets()->list(array $params)
NetBox::powerOutlets()->add(array $params)
NetBox::powerOutlets()->delete(int $id, array $params)
NetBox::powerOutlets()->edit(int $id, array $params)
NetBox::powerOutlets()->show(int $id, array $params)
NetBox::powerOutlets()->trace(int $id, array $params)
```
```php
NetBox::powerOutletTemplates()->list(array $params)
NetBox::powerOutletTemplates()->add(array $params)
NetBox::powerOutletTemplates()->delete(int $id, array $params)
NetBox::powerOutletTemplates()->edit(int $id, array $params)
NetBox::powerOutletTemplates()->show(int $id, array $params)
```
```php
NetBox::powerPanels()->list(array $params)
NetBox::powerPanels()->add(array $params)
NetBox::powerPanels()->delete(int $id, array $params)
NetBox::powerPanels()->edit(int $id, array $params)
NetBox::powerPanels()->show(int $id, array $params)
```
```php
NetBox::powerPorts()->list(array $params)
NetBox::powerPorts()->add(array $params)
NetBox::powerPorts()->delete(int $id, array $params)
NetBox::powerPorts()->edit(int $id, array $params)
NetBox::powerPorts()->show(int $id, array $params)
NetBox::powerPorts()->trace(int $id, array $params)
```
```php
NetBox::powerPortTemplates()->list(array $params)
NetBox::powerPortTemplates()->add(array $params)
NetBox::powerPortTemplates()->delete(int $id, array $params)
NetBox::powerPortTemplates()->edit(int $id, array $params)
NetBox::powerPortTemplates()->show(int $id, array $params)
```
```php
NetBox::rackGroups()->list(array $params)
NetBox::rackGroups()->add(array $params)
NetBox::rackGroups()->delete(int $id, array $params)
NetBox::rackGroups()->edit(int $id, array $params)
NetBox::rackGroups()->show(int $id, array $params)
```
```php
NetBox::rackReservations()->list(array $params)
NetBox::rackReservations()->add(array $params)
NetBox::rackReservations()->delete(int $id, array $params)
NetBox::rackReservations()->edit(int $id, array $params)
NetBox::rackReservations()->show(int $id, array $params)
```
```php
NetBox::rackRoles()->list(array $params)
NetBox::rackRoles()->add(array $params)
NetBox::rackRoles()->delete(int $id, array $params)
NetBox::rackRoles()->edit(int $id, array $params)
NetBox::rackRoles()->show(int $id, array $params)
```
```php
NetBox::racks()->list(array $params)
NetBox::racks()->add(array $params)
NetBox::racks()->delete(int $id, array $params)
NetBox::racks()->edit(int $id, array $params)
NetBox::racks()->show(int $id, array $params)
NetBox::racks()->elevation(int $id, array $params)
```
```php
NetBox::rearPorts()->list(array $params)
NetBox::rearPorts()->add(array $params)
NetBox::rearPorts()->delete(int $id, array $params)
NetBox::rearPorts()->edit(int $id, array $params)
NetBox::rearPorts()->show(int $id, array $params)
NetBox::rearPorts()->paths(int $id, array $params)
```
```php
NetBox::rearPortTemplates()->list(array $params)
NetBox::rearPortTemplates()->add(array $params)
NetBox::rearPortTemplates()->delete(int $id, array $params)
NetBox::rearPortTemplates()->edit(int $id, array $params)
NetBox::rearPortTemplates()->show(int $id, array $params)
```
```php
NetBox::regions()->list(array $params)
NetBox::regions()->add(array $params)
NetBox::regions()->delete(int $id, array $params)
NetBox::regions()->edit(int $id, array $params)
NetBox::regions()->show(int $id, array $params)
```
```php
NetBox::sites()->list(array $params)
NetBox::sites()->add(array $params)
NetBox::sites()->delete(int $id, array $params)
NetBox::sites()->edit(int $id, array $params)
NetBox::sites()->show(int $id, array $params)
```
```php
NetBox::virtualChassis()->list(array $params)
NetBox::virtualChassis()->add(array $params)
NetBox::virtualChassis()->delete(int $id, array $params)
NetBox::virtualChassis()->edit(int $id, array $params)
NetBox::virtualChassis()->show(int $id, array $params)
```
#### Extras
```php
NetBox::configContexts()->list(array $params)
NetBox::configContexts()->add(array $params)
NetBox::configContexts()->delete(int $id, array $params)
NetBox::configContexts()->edit(int $id, array $params)
NetBox::configContexts()->show(int $id, array $params)
```
```php
NetBox::contentTypes()->list(array $params)
NetBox::contentTypes()->show(int $id, array $params)
```
```php
NetBox::customFields()->list(array $params)
NetBox::customFields()->add(array $params)
NetBox::customFields()->delete(int $id, array $params)
NetBox::customFields()->edit(int $id, array $params)
NetBox::customFields()->show(int $id, array $params)
```
```php
NetBox::exportTemplates()->list(array $params)
NetBox::exportTemplates()->add(array $params)
NetBox::exportTemplates()->delete(int $id, array $params)
NetBox::exportTemplates()->edit(int $id, array $params)
NetBox::exportTemplates()->show(int $id, array $params)
```
```php
NetBox::imageAttachments()->list(array $params)
NetBox::imageAttachments()->add(array $params)
NetBox::imageAttachments()->delete(int $id, array $params)
NetBox::imageAttachments()->edit(int $id, array $params)
NetBox::imageAttachments()->show(int $id, array $params)
```
```php
NetBox::jobResults()->list(array $params)
NetBox::jobResults()->show(int $id, array $params)
```
```php
NetBox::objectChanges()->list(array $params)
NetBox::objectChanges()->show(int $id, array $params)
```
```php
NetBox::reports()->list(array $params)
NetBox::reports()->show(int $id, array $params)
NetBox::reports()->run(int $id, array $params)
```
```php
NetBox::scripts()->list(array $params)
NetBox::scripts()->show(int $id, array $params)
```
```php
NetBox::tags()->list(array $params)
NetBox::tags()->add(array $params)
NetBox::tags()->delete(int $id, array $params)
NetBox::tags()->edit(int $id, array $params)
NetBox::tags()->show(int $id, array $params)
```
#### IPAM
```php
NetBox::aggregates()->list(array $params)
NetBox::aggregates()->add(array $params)
NetBox::aggregates()->delete(int $id, array $params)
NetBox::aggregates()->edit(int $id, array $params)
NetBox::aggregates()->show(int $id, array $params)
```
```php
NetBox::ipAddresses()->list(array $params)
NetBox::ipAddresses()->add(array $params)
NetBox::ipAddresses()->delete(int $id, array $params)
NetBox::ipAddresses()->edit(int $id, array $params)
NetBox::ipAddresses()->show(int $id, array $params)
```
```php
NetBox::prefixes()->list(array $params)
NetBox::prefixes()->add(array $params)
NetBox::prefixes()->delete(int $id, array $params)
NetBox::prefixes()->edit(int $id, array $params)
NetBox::prefixes()->show(int $id, array $params)
NetBox::prefixes()->addAvailableIps(int $id, array $params)
NetBox::prefixes()->showAvailableIps(int $id, array $params)
NetBox::prefixes()->addAvailable(int $id, array $params)
NetBox::prefixes()->showAvailable(int $id, array $params)
```
```php
NetBox::rirs()->list(array $params)
NetBox::rirs()->add(array $params)
NetBox::rirs()->delete(int $id, array $params)
NetBox::rirs()->edit(int $id, array $params)
NetBox::rirs()->show(int $id, array $params)
```
```php
NetBox::roles()->list(array $params)
NetBox::roles()->add(array $params)
NetBox::roles()->delete(int $id, array $params)
NetBox::roles()->edit(int $id, array $params)
NetBox::roles()->show(int $id, array $params)
```
```php
NetBox::routeTargets()->list(array $params)
NetBox::routeTargets()->add(array $params)
NetBox::routeTargets()->delete(int $id, array $params)
NetBox::routeTargets()->edit(int $id, array $params)
NetBox::routeTargets()->show(int $id, array $params)
```
```php
NetBox::services()->list(array $params)
NetBox::services()->add(array $params)
NetBox::services()->delete(int $id, array $params)
NetBox::services()->edit(int $id, array $params)
NetBox::services()->show(int $id, array $params)
```
```php
NetBox::vlanGroups()->list(array $params)
NetBox::vlanGroups()->add(array $params)
NetBox::vlanGroups()->delete(int $id, array $params)
NetBox::vlanGroups()->edit(int $id, array $params)
NetBox::vlanGroups()->show(int $id, array $params)
```
```php
NetBox::vlans()->list(array $params)
NetBox::vlans()->add(array $params)
NetBox::vlans()->delete(int $id, array $params)
NetBox::vlans()->edit(int $id, array $params)
NetBox::vlans()->show(int $id, array $params)
```
```php
NetBox::vrfs()->list(array $params)
NetBox::vrfs()->add(array $params)
NetBox::vrfs()->delete(int $id, array $params)
NetBox::vrfs()->edit(int $id, array $params)
NetBox::vrfs()->show(int $id, array $params)
```
#### Secrets
```php
NetBox::keyGen()->list(array $params)
```
```php
NetBox::secrets()->list(array $params)
NetBox::secrets()->add(array $params)
NetBox::secrets()->delete(int $id, array $params)
NetBox::secrets()->edit(int $id, array $params)
NetBox::secrets()->show(int $id, array $params)
```
```php
NetBox::secretRoles()->list(array $params)
NetBox::secretRoles()->add(array $params)
NetBox::secretRoles()->delete(int $id, array $params)
NetBox::secretRoles()->edit(int $id, array $params)
NetBox::secretRoles()->show(int $id, array $params)
```
```php
NetBox::session()->list(array $params)
```
#### Tenancy
```php
NetBox::tenantGroups()->list(array $params)
NetBox::tenantGroups()->add(array $params)
NetBox::tenantGroups()->delete(int $id, array $params)
NetBox::tenantGroups()->edit(int $id, array $params)
NetBox::tenantGroups()->show(int $id, array $params)
```
```php
NetBox::tenants()->list(array $params)
NetBox::tenants()->add(array $params)
NetBox::tenants()->delete(int $id, array $params)
NetBox::tenants()->edit(int $id, array $params)
NetBox::tenants()->show(int $id, array $params)
```
#### Users
```php
NetBox::config()->list(array $params)
```
```php
NetBox::groups()->list(array $params)
NetBox::groups()->add(array $params)
NetBox::groups()->delete(int $id, array $params)
NetBox::groups()->edit(int $id, array $params)
NetBox::groups()->show(int $id, array $params)
```
```php
NetBox::permissions()->list(array $params)
NetBox::permissions()->add(array $params)
NetBox::permissions()->delete(int $id, array $params)
NetBox::permissions()->edit(int $id, array $params)
NetBox::permissions()->show(int $id, array $params)
```
```php
NetBox::users()->list(array $params)
NetBox::users()->add(array $params)
NetBox::users()->delete(int $id, array $params)
NetBox::users()->edit(int $id, array $params)
NetBox::users()->show(int $id, array $params)
```
#### Virtualization
```php
NetBox::clusterGroups()->list(array $params)
NetBox::clusterGroups()->add(array $params)
NetBox::clusterGroups()->delete(int $id, array $params)
NetBox::clusterGroups()->edit(int $id, array $params)
NetBox::clusterGroups()->show(int $id, array $params)
```
```php
NetBox::clusters()->list(array $params)
NetBox::clusters()->add(array $params)
NetBox::clusters()->delete(int $id, array $params)
NetBox::clusters()->edit(int $id, array $params)
NetBox::clusters()->show(int $id, array $params)
```
```php
NetBox::clusterTypes()->list(array $params)
NetBox::clusterTypes()->add(array $params)
NetBox::clusterTypes()->delete(int $id, array $params)
NetBox::clusterTypes()->edit(int $id, array $params)
NetBox::clusterTypes()->show(int $id, array $params)
```
```php
NetBox::vinterfaces()->list(array $params)
NetBox::vinterfaces()->add(array $params)
NetBox::vinterfaces()->delete(int $id, array $params)
NetBox::vinterfaces()->edit(int $id, array $params)
NetBox::vinterfaces()->show(int $id, array $params)
```
```php
NetBox::virtualMachines()->list(array $params)
NetBox::virtualMachines()->add(array $params)
NetBox::virtualMachines()->delete(int $id, array $params)
NetBox::virtualMachines()->edit(int $id, array $params)
NetBox::virtualMachines()->show(int $id, array $params)
```
- - -

View file

@ -31,6 +31,6 @@ class Reports extends AbstractApi
*/
public function run($id, $params=[])
{
return $this->post("/extras/reports/".$id."/", $params);
return $this->post("/extras/reports/".$id."/run/", $params);
}
}

View file

@ -2,14 +2,14 @@
namespace wickedsoft\NetBox\Api\Secrets;
class KeyGen extends AbstractApi
class Session extends AbstractApi
{
/**
* @param $params
* @return mixed
* @throws \GuzzleHttp\Exception\GuzzleException
*/
public function add($params=[])
public function list($params=[])
{
return $this->post("/secrets/get-session-key/", $params);
}

View file

@ -75,32 +75,28 @@ class Client
'vlans' => 'IPAM\Vlans',
'vrfs' => 'IPAM\Vrfs',
//circuits
'circuits' => 'Circuits',
'circuitTypes' => 'CircuitTypes',
'circuitTerminations' => 'CircuitTerminations',
'providers' => 'CircuitProviders',
//secrets
'keyGen' => 'Secrets\KeyGen',
'secrets' => 'Secrets\Secrets',
'secretRoles' => 'Secrets\SecretRoles',
'keyGen' => 'Secrets\KeyGen',
'session' => 'Secrets\Session',
//Tenancy
'tenantGroups' => 'Tenancy\TenantGroups',
'tenants' => 'Tenancy\Tenants',
//users
'config' => 'Users\Config',
'groups' => 'Users\Groups',
'permissions' => 'Users\Permissions',
'users' => 'Users\Users',
'config' => 'Users\Config',
//Virtualization
'clusterGroups' => 'Virtualization\ClusterGroups',
'clusterTypes' => 'Virtualization\ClusterTypes',
'clusters' => 'Virtualization\Clusters',
'clusterTypes' => 'Virtualization\ClusterTypes',
'vinterfaces' => 'Virtualization\Interfaces',
'virtualMachines' => 'Virtualization\VirtualMachines',
'status' => 'Status',