Documentation

SnmpApi

SnmpApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
__construct()  : mixed
getConfig()  : Configuration
getNetworkSnmp()  : object
Operation getNetworkSnmp
getNetworkSnmpAsync()  : PromiseInterface
Operation getNetworkSnmpAsync
getNetworkSnmpAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkSnmpAsyncWithHttpInfo
getNetworkSnmpWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkSnmpWithHttpInfo
getOrganizationSnmp()  : object
Operation getOrganizationSnmp
getOrganizationSnmpAsync()  : PromiseInterface
Operation getOrganizationSnmpAsync
getOrganizationSnmpAsyncWithHttpInfo()  : PromiseInterface
Operation getOrganizationSnmpAsyncWithHttpInfo
getOrganizationSnmpWithHttpInfo()  : array<string|int, mixed>
Operation getOrganizationSnmpWithHttpInfo
updateNetworkSnmp()  : object
Operation updateNetworkSnmp
updateNetworkSnmpAsync()  : PromiseInterface
Operation updateNetworkSnmpAsync
updateNetworkSnmpAsyncWithHttpInfo()  : PromiseInterface
Operation updateNetworkSnmpAsyncWithHttpInfo
updateNetworkSnmpWithHttpInfo()  : array<string|int, mixed>
Operation updateNetworkSnmpWithHttpInfo
updateOrganizationSnmp()  : object
Operation updateOrganizationSnmp
updateOrganizationSnmpAsync()  : PromiseInterface
Operation updateOrganizationSnmpAsync
updateOrganizationSnmpAsyncWithHttpInfo()  : PromiseInterface
Operation updateOrganizationSnmpAsyncWithHttpInfo
updateOrganizationSnmpWithHttpInfo()  : array<string|int, mixed>
Operation updateOrganizationSnmpWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getNetworkSnmpRequest()  : Request
Create request for operation 'getNetworkSnmp'
getOrganizationSnmpRequest()  : Request
Create request for operation 'getOrganizationSnmp'
updateNetworkSnmpRequest()  : Request
Create request for operation 'updateNetworkSnmp'
updateOrganizationSnmpRequest()  : Request
Create request for operation 'updateOrganizationSnmp'

Properties

$client

protected ClientInterface $client

Methods

getNetworkSnmp()

Operation getNetworkSnmp

public getNetworkSnmp(string $network_id) : object

Return the SNMP settings for a network

Parameters
$network_id : string

network_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getNetworkSnmpAsync()

Operation getNetworkSnmpAsync

public getNetworkSnmpAsync(string $network_id) : PromiseInterface

Return the SNMP settings for a network

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkSnmpAsyncWithHttpInfo()

Operation getNetworkSnmpAsyncWithHttpInfo

public getNetworkSnmpAsyncWithHttpInfo(string $network_id) : PromiseInterface

Return the SNMP settings for a network

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkSnmpWithHttpInfo()

Operation getNetworkSnmpWithHttpInfo

public getNetworkSnmpWithHttpInfo(string $network_id) : array<string|int, mixed>

Return the SNMP settings for a network

Parameters
$network_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationSnmp()

Operation getOrganizationSnmp

public getOrganizationSnmp(string $organization_id) : object

Return the SNMP settings for an organization

Parameters
$organization_id : string

organization_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getOrganizationSnmpAsync()

Operation getOrganizationSnmpAsync

public getOrganizationSnmpAsync(string $organization_id) : PromiseInterface

Return the SNMP settings for an organization

Parameters
$organization_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getOrganizationSnmpAsyncWithHttpInfo()

Operation getOrganizationSnmpAsyncWithHttpInfo

public getOrganizationSnmpAsyncWithHttpInfo(string $organization_id) : PromiseInterface

Return the SNMP settings for an organization

Parameters
$organization_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getOrganizationSnmpWithHttpInfo()

Operation getOrganizationSnmpWithHttpInfo

public getOrganizationSnmpWithHttpInfo(string $organization_id) : array<string|int, mixed>

Return the SNMP settings for an organization

Parameters
$organization_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkSnmp()

Operation updateNetworkSnmp

public updateNetworkSnmp(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : object

Update the SNMP settings for a network

Parameters
$network_id : string

network_id (required)

$update_network_snmp : UpdateNetworkSnmp = null

update_network_snmp (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

updateNetworkSnmpAsync()

Operation updateNetworkSnmpAsync

public updateNetworkSnmpAsync(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : PromiseInterface

Update the SNMP settings for a network

Parameters
$network_id : string

(required)

$update_network_snmp : UpdateNetworkSnmp = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNetworkSnmpAsyncWithHttpInfo()

Operation updateNetworkSnmpAsyncWithHttpInfo

public updateNetworkSnmpAsyncWithHttpInfo(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : PromiseInterface

Update the SNMP settings for a network

Parameters
$network_id : string

(required)

$update_network_snmp : UpdateNetworkSnmp = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateNetworkSnmpWithHttpInfo()

Operation updateNetworkSnmpWithHttpInfo

public updateNetworkSnmpWithHttpInfo(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : array<string|int, mixed>

Update the SNMP settings for a network

Parameters
$network_id : string

(required)

$update_network_snmp : UpdateNetworkSnmp = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

updateOrganizationSnmp()

Operation updateOrganizationSnmp

public updateOrganizationSnmp(string $organization_id[, UpdateOrganizationSnmp $update_organization_snmp = null ]) : object

Update the SNMP settings for an organization

Parameters
$organization_id : string

organization_id (required)

$update_organization_snmp : UpdateOrganizationSnmp = null

update_organization_snmp (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

updateOrganizationSnmpAsync()

Operation updateOrganizationSnmpAsync

public updateOrganizationSnmpAsync(string $organization_id[, UpdateOrganizationSnmp $update_organization_snmp = null ]) : PromiseInterface

Update the SNMP settings for an organization

Parameters
$organization_id : string

(required)

$update_organization_snmp : UpdateOrganizationSnmp = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateOrganizationSnmpAsyncWithHttpInfo()

Operation updateOrganizationSnmpAsyncWithHttpInfo

public updateOrganizationSnmpAsyncWithHttpInfo(string $organization_id[, UpdateOrganizationSnmp $update_organization_snmp = null ]) : PromiseInterface

Update the SNMP settings for an organization

Parameters
$organization_id : string

(required)

$update_organization_snmp : UpdateOrganizationSnmp = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

updateOrganizationSnmpWithHttpInfo()

Operation updateOrganizationSnmpWithHttpInfo

public updateOrganizationSnmpWithHttpInfo(string $organization_id[, UpdateOrganizationSnmp $update_organization_snmp = null ]) : array<string|int, mixed>

Update the SNMP settings for an organization

Parameters
$organization_id : string

(required)

$update_organization_snmp : UpdateOrganizationSnmp = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

getNetworkSnmpRequest()

Create request for operation 'getNetworkSnmp'

protected getNetworkSnmpRequest(string $network_id) : Request
Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

getOrganizationSnmpRequest()

Create request for operation 'getOrganizationSnmp'

protected getOrganizationSnmpRequest(string $organization_id) : Request
Parameters
$organization_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request

updateNetworkSnmpRequest()

Create request for operation 'updateNetworkSnmp'

protected updateNetworkSnmpRequest(string $network_id[, UpdateNetworkSnmp $update_network_snmp = null ]) : Request
Parameters
$network_id : string

(required)

$update_network_snmp : UpdateNetworkSnmp = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request

updateOrganizationSnmpRequest()

Create request for operation 'updateOrganizationSnmp'

protected updateOrganizationSnmpRequest(string $organization_id[, UpdateOrganizationSnmp $update_organization_snmp = null ]) : Request
Parameters
$organization_id : string

(required)

$update_organization_snmp : UpdateOrganizationSnmp = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request

Search results