Citrix ADC 12.1 NITRO API Reference

riseprofile

August 17, 2023

Contributed by:

Configuration for RISE profile resource.

Properties

(click to see Operations)

Name	Permissions	Description
profilename	Read-write	Name of the RISE profile. Minimum length = 1 Maximum length = 83
servicename	Read-only	RISE Service name. Minimum length = 1 Maximum length = 31
deviceid	Read-only	Device id. Minimum length = 1 Maximum length = 31
slotid	Read-only	Slot number of the RISE profile.
slotno	Read-only	Slot number of the RISE profile.
vdcid	Read-only	RISE vdc id.
vpcid	Read-only	RISE vpc id.
ipaddress	Read-only	RISE ip address.
mode	Read-only	RISE attach mode. Possible values = Direct, Indirect, vPC-Direct
status	Read-only	RISE status. Possible values = Active, Inactive
vlan	Read-only	RISE Vlan id.
vlangroupid	Read-only	RISE Vlan Group id.
vlancfgstatus	Read-only	RISE config status. Possible values = Ok, Invalid
ifnum	Read-only	RISE Interface number.
issu	Read-only	RISE issu status. Possible values = InProgress, None
__count	Read-only	count parameter

Operations

(click to see Properties)

GET (ALL)

GET

COUNT

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 Citrix ADC appliance, the URL is as follows:

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of riseprofile resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile?pagesize=#no;pageno=#no

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

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "riseprofile": [ {
"profilename":<String_value>,
"servicename":<String_value>,
"deviceid":<String_value>,
"slotid":<Double_value>,
"slotno":<Double_value>,
"vdcid":<Double_value>,
"vpcid":<Double_value>,
"ipaddress":<String_value>,
"mode":<String_value>,
"status":<String_value>,
"vlan":<Double_value>,
"vlangroupid":<Double_value>,
"vlancfgstatus":<String_value>,
"ifnum":<String_value>,
"issu":<String_value>
}]}

<!--NeedCopy-->

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile/profilename_value<String>

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile/profilename_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile/profilename_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

Content-Type:application/json

Response Payload:

{ "riseprofile": [ {
"profilename":<String_value>,
"servicename":<String_value>,
"deviceid":<String_value>,
"slotid":<Double_value>,
"slotno":<Double_value>,
"vdcid":<Double_value>,
"vpcid":<Double_value>,
"ipaddress":<String_value>,
"mode":<String_value>,
"status":<String_value>,
"vlan":<Double_value>,
"vlangroupid":<Double_value>,
"vlancfgstatus":<String_value>,
"ifnum":<String_value>,
"issu":<String_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/riseprofile?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

Content-Type:application/json

Response Payload:

{ "riseprofile": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

riseprofile

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

riseprofile

Properties

Operations

get (all)

get

count

In this article