Skip to content

device_profile

Configuration for Device Profile resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
svm_ns_comm <String> Read-write Communication protocol (http or https) with Instances.

Minimum length = 1

Maximum length = 10
name <String> Read-write Profile Name.

Minimum length = 1

Maximum length = 128
type <String> Read-write Profile Type, This must be with in specified supported instance types: blx,sdvanvw,ns,nssdx,cbwanopt,cpx.

Minimum length = 1

Maximum length = 128
id <String> Read-write Id is system generated key for all the device profiles.
use_global_setting_for_communication_with_ns <Boolean> Read-write True, if the communication with Instance needs to be global and not device specific.
ssl_private_key <String> Read-write SSL Private Key for key based authentication.
snmpauthprotocol <String> Read-write SNMP v3 auth protocol for this profile.
snmpsecurityname <String> Read-write SNMP v3 security name for this profile.

Maximum length = 31
ssl_cert <String> Read-write SSL Certificate for certificate based authentication.
http_port <Integer> Read-write HTTP port to connect to the device.
ns_profile_name <String> Read-write Profile Name, This is one of the already created Citrix ADC profiles.
ssh_port <String> Read-write SSH port to connect to the device.
password <String> Read-write Instance credentials.Password for this profile.

Minimum length = 1

Maximum length = 127
snmpsecuritylevel <String> Read-write SNMP v3 security level for this profile.
snmpcommunity <String> Read-write SNMP community for this profile.

Maximum length = 31
passphrase <String> Read-write Passphrase with which private key is encrypted.
snmpprivprotocol <String> Read-write SNMP v3 priv protocol for this profile.
https_port <Integer> Read-write HTTPS port to connect to the device.
username <String> Read-write Instance credentials.Username provided in the profile will be used to contact the instance.

Minimum length = 1

Maximum length = 127
host_password <String> Read-write Host Password for this profile.Used for BLX form factor of ADC.

Minimum length = 1

Maximum length = 127
max_wait_time_reboot <String> Read-write Max waiting time to reboot Citrix ADC.
snmpprivpassword <String> Read-write SNMP v3 priv password for this profile.

Minimum length = 8

Maximum length = 31
snmpversion <String> Read-write SNMP version for this profile.
host_username <String> Read-write Host User Name for this profile.Used for BLX form factor of ADC.

Minimum length = 1

Maximum length = 127
snmpauthpassword <String> Read-write SNMP v3 auth password for this profile.

Minimum length = 8

Maximum length = 31
cb_profile_name <String> Read-write Profile Name, This is one of the already created Citrix SD-WAN profiles.
tenant_id <String> Read-only Tenant Id of device profile.
is_default <Boolean> Read-only True, if this profile is system generated and can not be deleted.

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

add

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

HTTPS Method: POST

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

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>,
      "svm_ns_comm":<String_value>,
      "ssl_cert":<String_value>,
      "http_port":<Integer_value>,
      "ns_profile_name":<String_value>,
      "use_global_setting_for_communication_with_ns":<Boolean_value>,
      "ssh_port":<String_value>,
      "snmpsecuritylevel":<String_value>,
      "snmpcommunity":<String_value>,
      "passphrase":<String_value>,
      "id":<String_value>,
      "snmpprivprotocol":<String_value>,
      "https_port":<Integer_value>,
      "host_password":<String_value>,
      "max_wait_time_reboot":<String_value>,
      "snmpprivpassword":<String_value>,
      "type":<String_value>,
      "snmpversion":<String_value>,
      "cb_profile_name":<String_value>,
      "snmpauthpassword":<String_value>,
      "host_username":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>,
      "ssl_private_key":<String_value>,
      "snmpauthprotocol":<String_value>,
      "snmpsecurityname":<String_value>,
      "ssl_cert":<String_value>,
      "http_port":<Integer_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>,
      "https_port":<Integer_value>,
      "username":<String_value>,
      "host_password":<String_value>,
      "max_wait_time_reboot":<String_value>,
      "snmpprivpassword":<String_value>,
      "snmpversion":<String_value>,
      "host_username":<String_value>,
      "snmpauthpassword":<String_value>,
      "cb_profile_name":<String_value>}]}

delete

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

HTTPS Method: DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

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

get (all)

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

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/device_profile ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of device_profile resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/device_profile ?pagesize=#no;pageno=#no

Use this query-parameter to get the device_profile resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/device_profile ?count=yes

Use this query-parameter to get the count of device_profile resources.

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>,
      "ssl_private_key":<String_value>,
      "snmpauthprotocol":<String_value>,
      "snmpsecurityname":<String_value>,
      "ssl_cert":<String_value>,
      "http_port":<Integer_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>,
      "https_port":<Integer_value>,
      "username":<String_value>,
      "host_password":<String_value>,
      "max_wait_time_reboot":<String_value>,
      "snmpprivpassword":<String_value>,
      "snmpversion":<String_value>,
      "host_username":<String_value>,
      "snmpauthpassword":<String_value>,
      "cb_profile_name":<String_value>}]}

get

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

HTTPS Method: GET

Request Headers:

Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>,
      "ssl_private_key":<String_value>,
      "snmpauthprotocol":<String_value>,
      "snmpsecurityname":<String_value>,
      "ssl_cert":<String_value>,
      "http_port":<Integer_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>,
      "https_port":<Integer_value>,
      "username":<String_value>,
      "host_password":<String_value>,
      "max_wait_time_reboot":<String_value>,
      "snmpprivpassword":<String_value>,
      "snmpversion":<String_value>,
      "host_username":<String_value>,
      "snmpauthpassword":<String_value>,
      "cb_profile_name":<String_value>}]}

update

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

HTTPS Method: PUT

Request Headers:

Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"device_profile":{
<b>      "id":<String_value></b>,
      "ns_profile_name":<String_value>,
      "use_global_setting_for_communication_with_ns":<Boolean_value>,
      "password":<String_value>,
      "snmpsecuritylevel":<String_value>,
      "passphrase":<String_value>,
      "name":<String_value>,
      "username":<String_value>,
      "type":<String_value>,
      "host_username":<String_value>,
      "snmpsecurityname":<String_value>,
      "snmpauthprotocol":<String_value>,
      "ssl_private_key":<String_value>,
      "svm_ns_comm":<String_value>,
      "ssl_cert":<String_value>,
      "http_port":<Integer_value>,
      "ssh_port":<String_value>,
      "snmpcommunity":<String_value>,
      "snmpprivprotocol":<String_value>,
      "https_port":<Integer_value>,
      "host_password":<String_value>,
      "max_wait_time_reboot":<String_value>,
      "snmpprivpassword":<String_value>,
      "snmpversion":<String_value>,
      "cb_profile_name":<String_value>,
      "snmpauthpassword":<String_value>}}

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "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>,
      "ssl_private_key":<String_value>,
      "snmpauthprotocol":<String_value>,
      "snmpsecurityname":<String_value>,
      "ssl_cert":<String_value>,
      "http_port":<Integer_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>,
      "https_port":<Integer_value>,
      "username":<String_value>,
      "host_password":<String_value>,
      "max_wait_time_reboot":<String_value>,
      "snmpprivpassword":<String_value>,
      "snmpversion":<String_value>,
      "host_username":<String_value>,
      "snmpauthpassword":<String_value>,
      "cb_profile_name":<String_value>}]}
Was this article helpful?