Skip to content

device_profile

Configuration for Device Profile resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
svm_ns_comm<String>Read-writeCommunication with Instances.
Minimum length = 1
Maximum length = 10
tenant_id<String>Read-writeTenant Id of device profile.
Minimum length = 1
Maximum length = 128
is_default<Boolean>Read-writeTrue, if this profile is system generated and can not be deleted.
name<String>Read-writeProfile Name.
Minimum length = 1
Maximum length = 128
type<String>Read-writeProfile Type, This must be with in specified supported profiles (NS / Xen).
Minimum length = 1
Maximum length = 128
id<String>Read-writeId is system generated key for all the device profiles.
use_global_setting_for_communication_with_ns<Boolean>Read-writeTrue, if the communication with Instance needs to be global and not device specific.
wait_time_after_reboot<String>Read-writeWait time after reboot in seconds.
ssl_private_key<String>Read-writeSSL Private Key for key based authentication.
snmpauthprotocol<String>Read-writeSNMP v3 auth protocol for this profile.
snmpsecurityname<String>Read-writeSNMP v3 security name for this profile.
Maximum length = 31
ssl_cert<String>Read-writeSSL Certificate for certificate based authentication.
ns_profile_name<String>Read-writeProfile Name, This is one of the already created NetScaler profiles.
ssh_port<String>Read-writeSSH port to connect to the device.
password<String>Read-writePassword for this profile.
Minimum length = 1
Maximum length = 127
snmpsecuritylevel<String>Read-writeSNMP v3 security level for this profile.
snmpcommunity<String>Read-writeSNMP community for this profile.
Maximum length = 31
passphrase<String>Read-writePassphrase with which private key is encrypted.
snmpprivprotocol<String>Read-writeSNMP v3 priv protocol for this profile.
username<String>Read-writeUser Name for this profile.
Minimum length = 1
Maximum length = 127
snmpprivpassword<String>Read-writeSNMP v3 priv password for this profile.
Minimum length = 8
Maximum length = 31
snmpversion<String>Read-writeSNMP version for this profile.
snmpauthpassword<String>Read-writeSNMP v3 auth password for this profile.
Minimum length = 8
Maximum length = 31
cb_profile_name<String>Read-writeProfile Name, This is one of the already created NetScaler SD-WAN profiles.

Operations

(click to see Properties)

ADD| DELETE| GET (ALL)| GET| UPDATE

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: https://<MGMT-IP>/nitro/v1/config/device_profile?onerror=<String_value>

HTTP Method: null

Request Payload:

{device_profile: {
<b>"name":<String_value></b>,
<b>"password":<String_value></b>,
<b>"username":<String_value></b>,
"snmpsecurityname":<String_value>,
"snmpauthprotocol":<String_value>,
"ssl_private_key":<String_value>,
"wait_time_after_reboot":<String_value>,
"svm_ns_comm":<String_value>,
"ssl_cert":<String_value>,
"ns_profile_name":<String_value>,
"use_global_setting_for_communication_with_ns":<Boolean_value>,
"ssh_port":<String_value>,
"tenant_id":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"passphrase":<String_value>,
"id":<String_value>,
"is_default":<Boolean_value>,
"snmpprivprotocol":<String_value>,
"snmpprivpassword":<String_value>,
"type":<String_value>,
"snmpversion":<String_value>,
"cb_profile_name":<String_value>,
"snmpauthpassword":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_profile":[{
"svm_ns_comm":<String_value>,
"tenant_id":<String_value>,
"is_default":<Boolean_value>,
"name":<String_value>,
"type":<String_value>,
"id":<String_value>,
"use_global_setting_for_communication_with_ns":<Boolean_value>,
"wait_time_after_reboot":<String_value>,
"ssl_private_key":<String_value>,
"snmpauthprotocol":<String_value>,
"snmpsecurityname":<String_value>,
"ssl_cert":<String_value>,
"ns_profile_name":<String_value>,
"ssh_port":<String_value>,
"password":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"passphrase":<String_value>,
"snmpprivprotocol":<String_value>,
"username":<String_value>,
"snmpprivpassword":<String_value>,
"snmpversion":<String_value>,
"snmpauthpassword":<String_value>,
"cb_profile_name":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/device_profile/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/device_profile

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_profile":[{
"svm_ns_comm":<String_value>,
"tenant_id":<String_value>,
"is_default":<Boolean_value>,
"name":<String_value>,
"type":<String_value>,
"id":<String_value>,
"use_global_setting_for_communication_with_ns":<Boolean_value>,
"wait_time_after_reboot":<String_value>,
"ssl_private_key":<String_value>,
"snmpauthprotocol":<String_value>,
"snmpsecurityname":<String_value>,
"ssl_cert":<String_value>,
"ns_profile_name":<String_value>,
"ssh_port":<String_value>,
"password":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"passphrase":<String_value>,
"snmpprivprotocol":<String_value>,
"username":<String_value>,
"snmpprivpassword":<String_value>,
"snmpversion":<String_value>,
"snmpauthpassword":<String_value>,
"cb_profile_name":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/device_profile/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_profile":[{
"svm_ns_comm":<String_value>,
"tenant_id":<String_value>,
"is_default":<Boolean_value>,
"name":<String_value>,
"type":<String_value>,
"id":<String_value>,
"use_global_setting_for_communication_with_ns":<Boolean_value>,
"wait_time_after_reboot":<String_value>,
"ssl_private_key":<String_value>,
"snmpauthprotocol":<String_value>,
"snmpsecurityname":<String_value>,
"ssl_cert":<String_value>,
"ns_profile_name":<String_value>,
"ssh_port":<String_value>,
"password":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"passphrase":<String_value>,
"snmpprivprotocol":<String_value>,
"username":<String_value>,
"snmpprivpassword":<String_value>,
"snmpversion":<String_value>,
"snmpauthpassword":<String_value>,
"cb_profile_name":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/device_profile/id_value<String>

HTTP Method: null

Request Payload:

{device_profile:{
<b>"id":<String_value></b>,
"snmpsecurityname":<String_value>,
"snmpauthprotocol":<String_value>,
"ssl_private_key":<String_value>,
"wait_time_after_reboot":<String_value>,
"svm_ns_comm":<String_value>,
"ssl_cert":<String_value>,
"ns_profile_name":<String_value>,
"use_global_setting_for_communication_with_ns":<Boolean_value>,
"ssh_port":<String_value>,
"password":<String_value>,
"tenant_id":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"passphrase":<String_value>,
"is_default":<Boolean_value>,
"name":<String_value>,
"snmpprivprotocol":<String_value>,
"username":<String_value>,
"snmpprivpassword":<String_value>,
"type":<String_value>,
"snmpversion":<String_value>,
"cb_profile_name":<String_value>,
"snmpauthpassword":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "device_profile":[{
"svm_ns_comm":<String_value>,
"tenant_id":<String_value>,
"is_default":<Boolean_value>,
"name":<String_value>,
"type":<String_value>,
"id":<String_value>,
"use_global_setting_for_communication_with_ns":<Boolean_value>,
"wait_time_after_reboot":<String_value>,
"ssl_private_key":<String_value>,
"snmpauthprotocol":<String_value>,
"snmpsecurityname":<String_value>,
"ssl_cert":<String_value>,
"ns_profile_name":<String_value>,
"ssh_port":<String_value>,
"password":<String_value>,
"snmpsecuritylevel":<String_value>,
"snmpcommunity":<String_value>,
"passphrase":<String_value>,
"snmpprivprotocol":<String_value>,
"username":<String_value>,
"snmpprivpassword":<String_value>,
"snmpversion":<String_value>,
"snmpauthpassword":<String_value>,
"cb_profile_name":<String_value>}]}