ProfilesApi
ProfilesApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkSmProfiles() : object
- Operation getNetworkSmProfiles
- getNetworkSmProfilesAsync() : PromiseInterface
- Operation getNetworkSmProfilesAsync
- getNetworkSmProfilesAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkSmProfilesAsyncWithHttpInfo
- getNetworkSmProfilesWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkSmProfilesWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilePort() : object
- Operation getOrganizationConfigTemplateSwitchProfilePort
- getOrganizationConfigTemplateSwitchProfilePortAsync() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilePortAsync
- getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilePorts() : object
- Operation getOrganizationConfigTemplateSwitchProfilePorts
- getOrganizationConfigTemplateSwitchProfilePortsAsync() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilePortsAsync
- getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo
- getOrganizationConfigTemplateSwitchProfiles() : object
- Operation getOrganizationConfigTemplateSwitchProfiles
- getOrganizationConfigTemplateSwitchProfilesAsync() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilesAsync
- getOrganizationConfigTemplateSwitchProfilesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationConfigTemplateSwitchProfilesAsyncWithHttpInfo
- getOrganizationConfigTemplateSwitchProfilesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationConfigTemplateSwitchProfilesWithHttpInfo
- updateOrganizationConfigTemplateSwitchProfilePort() : object
- Operation updateOrganizationConfigTemplateSwitchProfilePort
- updateOrganizationConfigTemplateSwitchProfilePortAsync() : PromiseInterface
- Operation updateOrganizationConfigTemplateSwitchProfilePortAsync
- updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo
- updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkSmProfilesRequest() : Request
- Create request for operation 'getNetworkSmProfiles'
- getOrganizationConfigTemplateSwitchProfilePortRequest() : Request
- Create request for operation 'getOrganizationConfigTemplateSwitchProfilePort'
- getOrganizationConfigTemplateSwitchProfilePortsRequest() : Request
- Create request for operation 'getOrganizationConfigTemplateSwitchProfilePorts'
- getOrganizationConfigTemplateSwitchProfilesRequest() : Request
- Create request for operation 'getOrganizationConfigTemplateSwitchProfiles'
- updateOrganizationConfigTemplateSwitchProfilePortRequest() : Request
- Create request for operation 'updateOrganizationConfigTemplateSwitchProfilePort'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkSmProfiles()
Operation getNetworkSmProfiles
public
getNetworkSmProfiles(string $network_id) : object
List all profiles in a network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkSmProfilesAsync()
Operation getNetworkSmProfilesAsync
public
getNetworkSmProfilesAsync(string $network_id) : PromiseInterface
List all profiles in a network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkSmProfilesAsyncWithHttpInfo()
Operation getNetworkSmProfilesAsyncWithHttpInfo
public
getNetworkSmProfilesAsyncWithHttpInfo(string $network_id) : PromiseInterface
List all profiles in a network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkSmProfilesWithHttpInfo()
Operation getNetworkSmProfilesWithHttpInfo
public
getNetworkSmProfilesWithHttpInfo(string $network_id) : array<string|int, mixed>
List all profiles in a network
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationConfigTemplateSwitchProfilePort()
Operation getOrganizationConfigTemplateSwitchProfilePort
public
getOrganizationConfigTemplateSwitchProfilePort(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : object
Return a switch profile port
Parameters
- $organization_id : string
-
organization_id (required)
- $config_template_id : string
-
config_template_id (required)
- $profile_id : string
-
profile_id (required)
- $port_id : string
-
port_id (required)
Tags
Return values
object —getOrganizationConfigTemplateSwitchProfilePortAsync()
Operation getOrganizationConfigTemplateSwitchProfilePortAsync
public
getOrganizationConfigTemplateSwitchProfilePortAsync(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : PromiseInterface
Return a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : PromiseInterface
Return a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilePorts()
Operation getOrganizationConfigTemplateSwitchProfilePorts
public
getOrganizationConfigTemplateSwitchProfilePorts(string $organization_id, string $config_template_id, string $profile_id) : object
Return all the ports of a switch profile
Parameters
- $organization_id : string
-
organization_id (required)
- $config_template_id : string
-
config_template_id (required)
- $profile_id : string
-
profile_id (required)
Tags
Return values
object —getOrganizationConfigTemplateSwitchProfilePortsAsync()
Operation getOrganizationConfigTemplateSwitchProfilePortsAsync
public
getOrganizationConfigTemplateSwitchProfilePortsAsync(string $organization_id, string $config_template_id, string $profile_id) : PromiseInterface
Return all the ports of a switch profile
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilePortsAsyncWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id) : PromiseInterface
Return all the ports of a switch profile
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilePortsWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id) : array<string|int, mixed>
Return all the ports of a switch profile
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilePortWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : array<string|int, mixed>
Return a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationConfigTemplateSwitchProfiles()
Operation getOrganizationConfigTemplateSwitchProfiles
public
getOrganizationConfigTemplateSwitchProfiles(string $organization_id, string $config_template_id) : object
List the switch profiles for your switch template configuration
Parameters
- $organization_id : string
-
organization_id (required)
- $config_template_id : string
-
config_template_id (required)
Tags
Return values
object —getOrganizationConfigTemplateSwitchProfilesAsync()
Operation getOrganizationConfigTemplateSwitchProfilesAsync
public
getOrganizationConfigTemplateSwitchProfilesAsync(string $organization_id, string $config_template_id) : PromiseInterface
List the switch profiles for your switch template configuration
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilesAsyncWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilesAsyncWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilesAsyncWithHttpInfo(string $organization_id, string $config_template_id) : PromiseInterface
List the switch profiles for your switch template configuration
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationConfigTemplateSwitchProfilesWithHttpInfo()
Operation getOrganizationConfigTemplateSwitchProfilesWithHttpInfo
public
getOrganizationConfigTemplateSwitchProfilesWithHttpInfo(string $organization_id, string $config_template_id) : array<string|int, mixed>
List the switch profiles for your switch template configuration
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationConfigTemplateSwitchProfilePort()
Operation updateOrganizationConfigTemplateSwitchProfilePort
public
updateOrganizationConfigTemplateSwitchProfilePort(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : object
Update a switch profile port
Parameters
- $organization_id : string
-
organization_id (required)
- $config_template_id : string
-
config_template_id (required)
- $profile_id : string
-
profile_id (required)
- $port_id : string
-
port_id (required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
update_organization_config_template_switch_profile_port (optional)
Tags
Return values
object —updateOrganizationConfigTemplateSwitchProfilePortAsync()
Operation updateOrganizationConfigTemplateSwitchProfilePortAsync
public
updateOrganizationConfigTemplateSwitchProfilePortAsync(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : PromiseInterface
Update a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo()
Operation updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo
public
updateOrganizationConfigTemplateSwitchProfilePortAsyncWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : PromiseInterface
Update a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo()
Operation updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo
public
updateOrganizationConfigTemplateSwitchProfilePortWithHttpInfo(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : array<string|int, mixed>
Update a switch profile port
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
(optional)
Tags
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
Return values
array<string|int, mixed> —of http client options
getNetworkSmProfilesRequest()
Create request for operation 'getNetworkSmProfiles'
protected
getNetworkSmProfilesRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getOrganizationConfigTemplateSwitchProfilePortRequest()
Create request for operation 'getOrganizationConfigTemplateSwitchProfilePort'
protected
getOrganizationConfigTemplateSwitchProfilePortRequest(string $organization_id, string $config_template_id, string $profile_id, string $port_id) : Request
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
Tags
Return values
Request —getOrganizationConfigTemplateSwitchProfilePortsRequest()
Create request for operation 'getOrganizationConfigTemplateSwitchProfilePorts'
protected
getOrganizationConfigTemplateSwitchProfilePortsRequest(string $organization_id, string $config_template_id, string $profile_id) : Request
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
Tags
Return values
Request —getOrganizationConfigTemplateSwitchProfilesRequest()
Create request for operation 'getOrganizationConfigTemplateSwitchProfiles'
protected
getOrganizationConfigTemplateSwitchProfilesRequest(string $organization_id, string $config_template_id) : Request
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
Tags
Return values
Request —updateOrganizationConfigTemplateSwitchProfilePortRequest()
Create request for operation 'updateOrganizationConfigTemplateSwitchProfilePort'
protected
updateOrganizationConfigTemplateSwitchProfilePortRequest(string $organization_id, string $config_template_id, string $profile_id, string $port_id[, UpdateOrganizationConfigTemplateSwitchProfilePort $update_organization_config_template_switch_profile_port = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $config_template_id : string
-
(required)
- $profile_id : string
-
(required)
- $port_id : string
-
(required)
- $update_organization_config_template_switch_profile_port : UpdateOrganizationConfigTemplateSwitchProfilePort = null
-
(optional)