allconfigpacks¶
Configuration for Configpack Configuration resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
targets | <Object> | Read-write | Target devices that are used to instantiate the StyleBook. |
namespace | <String> | Read-write | Namespace of the StyleBook.
Minimum length = 1 Maximum length = 32 |
version | <String> | Read-write | Version of the StyleBook.
Minimum length = 1 Maximum length = 32 |
name | <String> | Read-write | Name of the StyleBook. |
target_devices_json | <Object> | Read-write | Target devices that are used to instantiate the StyleBook. |
parameters | <Object> | Read-write | Parameters used to instantiate the configuration for the stylebook. Please refer to the schema api to view the supported parameters for any stylebook. |
created_datetime | <String> | Read-write | Datetime the configuration for a stylebook was created.
Minimum length = 1 Maximum length = 128 |
id | <String> | Read-write | Config ID for the config pack. |
config_id | <String> | Read-write | Config ID for the config pack. |
Operations¶
(click to see Properties )
- GET (ALL)
- GET
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
get (all)¶
URL: https://<MGMT-IP>/nitro/v2/config/allconfigpacks Query-parameters:
HTTPS Method: GET
HTTPS 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: JSON
{ "allconfigpacks":[{
"targets":<Object_value>,
"outputs":<Object_value>,
"namespace":<String_value>,
"version":<String_value>,
"name":<String_value>,
"target_devices_json":<Object_value>,
"parameters":<Object_value>,
"created_datetime":<String_value>,
"id":<String_value>,
"config_id":<String_value>}]}
URL: https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<version_value>/<name_value>/<config_id_value>/configpacks
HTTPS Method: GET
HTTPS 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: JSON
{ "configpacks":{
"targets":<Object_value>,
"outputs":<Object_value>,
"namespace":<String_value>,
"version":<String_value>,
"name":<String_value>,
"target_devices_json":<Object_value>,
"parameters":<Object_value>,
"created_datetime":<String_value>,
"id":<String_value>,
"config_id":<String_value>}}