SwaggerClient-php

This is the iDirect iVantage API.

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/bkd27/i-vantage_api"
    }
  ],
  "require": {
    "bkd27/i-vantage_api": "2.0.*"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');
// Configure API key authorization: cookieAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Session', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Session', 'Bearer');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(['verify'=>false]),
    $config
);
$applicationservicegroup_id = 56; // int | ID of the applicationservicegroup

try {
    $result = $apiInstance->applicationservicegroupApplicationservicegroupIdGet($applicationservicegroup_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->applicationservicegroupApplicationservicegroupIdGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://nodenms_server/api/v1/evo/config/obj

Class	Method	HTTP request	Description
DefaultApi	[**
applicationservicegroupApplicationservicegroupIdGet**](docs/Api/DefaultApi.md#applicationservicegroupapplicationservicegroupidget)	**
GET** /applicationservicegroup/{applicationservicegroupId}
DefaultApi	[**
applicationservicegroupApplicationservicegroupIdPatch**](docs/Api/DefaultApi.md#applicationservicegroupapplicationservicegroupidpatch)	**
PATCH** /applicationservicegroup/{applicationservicegroupId}
DefaultApi	applicationservicegroupGet	**
GET** /applicationservicegroup
DefaultApi	authorizePost	POST /authorize
DefaultApi	bucBucIdGet	GET /buc/{bucId}
DefaultApi	bucGet	GET /buc
DefaultApi	carrierCarrierIdDelete	**
DELETE** /carrier/{carrierId}
DefaultApi	carrierCarrierIdGet	GET /carrier/{carrierId}
DefaultApi	carrierCarrierIdPatch	**
PATCH** /carrier/{carrierId}
DefaultApi	carrierGet	GET /carrier
DefaultApi	carrierPost	POST /carrier
DefaultApi	downconverterDownconverterIdDelete	**
DELETE** /downconverter/{downconverterId}
DefaultApi	downconverterDownconverterIdGet	**
GET** /downconverter/{downconverterId}
DefaultApi	downconverterDownconverterIdPatch	**
PATCH** /downconverter/{downconverterId}
DefaultApi	downconverterGet	GET /downconverter
DefaultApi	downconverterPost	POST /downconverter
DefaultApi	hubrftGet	GET /hubrft
DefaultApi	hubrftHubrftIdDelete	DELETE /hubrft/{hubrftId}
DefaultApi	hubrftHubrftIdGet	GET /hubrft/{hubrftId}
DefaultApi	hubrftHubrftIdPatch	PATCH /hubrft/{hubrftId}
DefaultApi	hubrftPost	POST /hubrft
DefaultApi	inroutegroupGet	GET /inroutegroup
DefaultApi	inroutegroupInroutegroupIdDelete	**
DELETE** /inroutegroup/{inroutegroupId}
DefaultApi	inroutegroupInroutegroupIdGet	**
GET** /inroutegroup/{inroutegroupId}
DefaultApi	inroutegroupInroutegroupIdPatch	**
PATCH** /inroutegroup/{inroutegroupId}
DefaultApi	inroutegroupPost	POST /inroutegroup
DefaultApi	linecardGet	GET /linecard
DefaultApi	linecardLinecardIdDelete	**
DELETE** /linecard/{linecardId}
DefaultApi	linecardLinecardIdGet	**
GET** /linecard/{linecardId}
DefaultApi	linecardLinecardIdPatch	**
PATCH** /linecard/{linecardId}
DefaultApi	linecardPost	POST /linecard
DefaultApi	lnbGet	GET /lnb
DefaultApi	lnbLnbIdGet	GET /lnb/{lnbId}
DefaultApi	networkGet	GET /network
DefaultApi	networkNetworkIdDelete	**
DELETE** /network/{networkId}
DefaultApi	networkNetworkIdGet	GET /network/{networkId}
DefaultApi	networkNetworkIdPatch	**
PATCH** /network/{networkId}
DefaultApi	networkPost	POST /network
DefaultApi	reflectorGet	GET /reflector
DefaultApi	reflectorReflectorIdGet	**
GET** /reflector/{reflectorId}
DefaultApi	remoteGet	GET /remote
DefaultApi	remotePost	POST /remote
DefaultApi	[**
remoteRemoteIdAddRoamingInstancePost**](docs/Api/DefaultApi.md#remoteremoteidaddroaminginstancepost)	**
POST** /remote/{remoteId}/add_roaming_instance
DefaultApi	remoteRemoteIdApplyChangesPatch	**
PATCH** /remote/{remoteId}/apply_changes
DefaultApi	remoteRemoteIdDelete	DELETE /remote/{remoteId}
DefaultApi	remoteRemoteIdGet	GET /remote/{remoteId}
DefaultApi	remoteRemoteIdPatch	PATCH /remote/{remoteId}
DefaultApi	remoteRemoteIdRawOptionsfileGet	**
GET** /remote/{remoteId}/raw_optionsfile
DefaultApi	remoteRemoteIdResetPatch	**
PATCH** /remote/{remoteId}/reset
DefaultApi	remoteRemoteIdStatusGet	**
GET** /remote/{remoteId}/status
DefaultApi	remoteRemoteIdStopCwPnPatch	**
PATCH** /remote/{remoteId}/stop_cw_pn
DefaultApi	remoteRemoteIdTxCwPatch	**
PATCH** /remote/{remoteId}/tx_cw
DefaultApi	remoteRemoteIdTxPnPatch	**
PATCH** /remote/{remoteId}/tx_pn
DefaultApi	remoteservicegroupGet	GET /remoteservicegroup
DefaultApi	[**
remoteservicegroupRemoteservicegroupIdGet**](docs/Api/DefaultApi.md#remoteservicegroupremoteservicegroupidget)	**
GET** /remoteservicegroup/{remoteservicegroupId}
DefaultApi	[**
remoteservicegroupRemoteservicegroupIdPatch**](docs/Api/DefaultApi.md#remoteservicegroupremoteservicegroupidpatch)	**
PATCH** /remoteservicegroup/{remoteservicegroupId}
DefaultApi	spacecraftGet	GET /spacecraft
DefaultApi	spacecraftPost	POST /spacecraft
DefaultApi	spacecraftSpacecraftIdDelete	**
DELETE** /spacecraft/{spacecraftId}
DefaultApi	spacecraftSpacecraftIdGet	**
GET** /spacecraft/{spacecraftId}
DefaultApi	spacecraftSpacecraftIdPatch	**
PATCH** /spacecraft/{spacecraftId}
DefaultApi	teleportGet	GET /teleport
DefaultApi	teleportPost	POST /teleport
DefaultApi	teleportTeleportIdDelete	**
DELETE** /teleport/{teleportId}
DefaultApi	teleportTeleportIdGet	**
GET** /teleport/{teleportId}
DefaultApi	teleportTeleportIdPatch	**
PATCH** /teleport/{teleportId}
DefaultApi	upconverterGet	GET /upconverter
DefaultApi	upconverterPost	POST /upconverter
DefaultApi	upconverterUpconverterIdDelete	**
DELETE** /upconverter/{upconverterId}
DefaultApi	upconverterUpconverterIdGet	**
GET** /upconverter/{upconverterId}
DefaultApi	upconverterUpconverterIdPatch	**
PATCH** /upconverter/{upconverterId}
DefaultApi	userGet	GET /user
DefaultApi	userPost	POST /user
DefaultApi	userUserIdGet	GET /user/{userId}
DefaultApi	userUserIdPatch	PATCH /user/{userId}

Documentation For Models

• AggregateAddress
• ApplicationMember
• ApplicationServiceGroup
• ApplicationServiceGroupConfiguredRates
• ApplicationServiceGroupEffectiveRates
• ApplicationServiceGroupEffectiveRatesMirModcodTable
• ApplicationServiceGroupListItem
• ApplicationServiceGroupListResponse
• ApplicationServiceGroupResponse
• ApplyChanges
• ApplyChangesRequest
• ApplyChangesResponse
• BUC
• BUCListItem
• BUCListResponse
• BUCResponse
• CW
• Carrier
• CarrierListItem
• CarrierListResponse
• CarrierResponse
• Composition
• ConfigTables
• DhcpClnAddrRange
• DiscretePort
• DownConverter
• DownConverterListItem
• DownConverterListResponse
• DownConverterResponse
• ElevationGain
• Error
• Errors
• GreTunnel
• HubRFT
• HubRFTListItem
• HubRFTListResponse
• HubRFTResponse
• InrouteGroup
• InrouteGroupAdaptive
• InrouteGroupListItem
• InrouteGroupListResponse
• InrouteGroupMesh
• InrouteGroupResponse
• InrouteGroupTimeplan
• LNB
• LNBListItem
• LNBListResponse
• LNBResponse
• Linecard
• LinecardResponse
• MCGroup
• Meta
• MulticastGroup
• Network
• NetworkListItem
• NetworkListResponse
• NetworkResponse
• PN
• PeerGroups
• Peers
• PortForward
• RXCarrier
• Reflector
• ReflectorAntennaController
• ReflectorListItem
• ReflectorListResponse
• ReflectorResponse
• Remote
• RemoteAntennaComponents
• RemoteAntennaComponentsOpenAMIPAntennaController
• RemoteAntennaComponentsOrbitSBCAntennaController
• RemoteAntennaComponentsSeaTelDACAntennaController
• RemoteCustomKeys
• RemoteCustomer
• RemoteL2oS
• RemoteL2oSHeaderCompression
• RemoteListItem
• RemoteListResponse
• RemoteMember
• RemoteMesh
• RemoteMobile
• RemoteRemoteQOS
• RemoteRemoteQOSDSDistributor
• RemoteRemoteQOSDSQOS
• RemoteRemoteQOSDSRateShaping
• RemoteRemoteQOSIdleDormant
• RemoteRemoteQOSUSAdaptive
• RemoteRemoteQOSUSQOS
• RemoteResponse
• RemoteSecondReceiver
• RemoteSecondReceiverSecondRxPort
• RemoteServiceGroup
• RemoteServiceGroupListItem
• RemoteServiceGroupListResponse
• RemoteServiceGroupResponse
• RoamingInstance
• RoamingRemote
• RouteMaps
• Rule
• RuleIPPrefix
• SVN
• SVNL3
• SVNL3BGP
• SVNL3BGPORF
• SVNL3BGPRouteRedistribution
• SkewGain
• Spacecraft
• SpacecraftListItem
• SpacecraftListResponse
• SpacecraftResponse
• StaticRoute
• Status
• StatusResponse
• SwitchPort
• Teleport
• TeleportListItem
• TeleportListResponse
• TeleportResponse
• UpConverter
• UpConverterListItem
• UpConverterListResponse
• UpConverterResponse
• User
• UserListItem
• UserListResponse
• UserResponse
• VLanInfo
• VLanInfoDHCP
• VLanInfoDNS

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

cookieAuth

• Type: API key
• API key parameter name: Session
• Location: HTTP header

Author

Bharat Kumar Dhaker