29 lines
12 KiB
HTML
29 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>configpacks</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">configpacks</p>
|
|
<P>Configuration for Configpack Configuration resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">namespace<span class="property_type"><String></span></p><p class="property_description">Namespace of the StyleBook.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Name of the StyleBook.</p>
|
|
<p class="property_name">target_devices_json<span class="property_type"><Object></span></p><p class="property_description">Target devices that are used to instantiate the StyleBook.</p>
|
|
<p class="property_name">version<span class="property_type"><String></span></p><p class="property_description">Version of the StyleBook.<br> Minimum length = 1<br> Maximum length = 32</p>
|
|
<p class="property_name">config_id<span class="property_type"><String></span></p><p class="property_description">Config ID for the config pack.</p>
|
|
<p class="property_name">job_id<span class="property_type"><String></span></p><p class="property_description">Config ID for the config pack.</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Config ID for the config pack.</p>
|
|
<p class="property_name">parameters<span class="property_type"><Object></span></p><p class="property_description">Parameters used to instantiate the configuration for the stylebook. Please refer to the schema api to view the supported parameters for any stylebook.</p>
|
|
<p class="property_name">targets<span class="property_type"><Object></span></p><p class="property_description">Target devices that are used to instantiate the StyleBook.</p>
|
|
<p class="property_name">created_datetime<span class="property_type"><String></span></p><p class="property_description">Datetime the configuration for a stylebook was created.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">outputs<span class="property_type"><Object></span></p><p class="property_description">Outputs that are obtained after instantiating the stylebook definition. .</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#add" class="operation">add</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><a href="#update" class="operation">update</a><a href="#delete" class="operation">delete</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<name_value>/<version_value>//configpacks<p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"configpack": {<br> "parameters":< property_value></font><br> "targets":< property_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "configpack":{<br> "config_id":< property_value></font><br> "job_id":< property_value></font>}}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/configpacks</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "configpacks":[{<br> "namespace":<String_value></font>,<br> "name":<String_value></font>,<br> "outputs":<Object_value></font>,<br> "target_devices_json":<Object_value></font>,<br> "version":<String_value></font>,<br> "config_id":<String_value></font>,<br> "job_id":<String_value></font>,<br> "id":<String_value></font>,<br> "parameters":<Object_value></font>,<br> "targets":<Object_value></font>,<br> "created_datetime":<String_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<name_value>/<version_value>/<config_id_value>/configpacks</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "configpack":{<br> "namespace":<String_value></font>,<br> "name":<String_value></font>,<br> "outputs":<Object_value></font>,<br> "target_devices_json":<Object_value></font>,<br> "version":<String_value></font>,<br> "config_id":<String_value></font>,<br> "job_id":<String_value></font>,<br> "id":<String_value></font>,<br> "parameters":<Object_value></font>,<br> "targets":<Object_value></font>,<br> "created_datetime":<String_value></font>}}</p><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<name_value>/<version_value>/<config_id_value>/configpacks/<config_id_value></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"configpack":{}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "configpack":{<br> "config_id":< property_value></font><br> "job_id":< property_value></font>}}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/stylebooks/<namespace_value>/<name_value>/<version_value>/<config_id_value>/configpacks/<config_id_value></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "configpack":{<br> "config_id":< property_value></font><br> "job_id":< property_value></font>}}</p>
|
|
</body>
|
|
</html>
|