Developer Documentation
ADM NITRO APIs

eventrule_config_command

June 20, 2023
Contributed by: 
C

Configuration for Configuration Commands for use in configuration template resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
protocol Read-write Protocol used by Configuration Command: SSH|SCP|SFTP.

Minimum length = 1

Maximum length = 32
index Read-write Index that stores the position of the command in a command array.
parent_name Read-write Name of the parent rule.
timeout Read-write Command Timeout in secs.

Maximum value =
nitro_payload Read-write NITRO Request Payload.
nitro_resource Read-write NITRO Resource Name.

Minimum length = 1

Maximum length = 128
id Read-write Id is system generated key.
nitro_method Read-write NITRO Request Method: POST|PUT|DELETE.

Minimum length = 1

Maximum length = 32
command Read-write Command String for Protocols SSH|SCP|SFTP.
parent_id Read-write Id of parent rule.

Operations

(click to see Properties )

  • GET (ALL)

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/eventrule_config_command Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/eventrule_config_command ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of eventrule_config_command 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/eventrule_config_command ?pagesize=#no;pageno=#no Use this query-parameter to get the eventrule_config_command resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/eventrule_config_command ?count=yes Use this query-parameter to get the count of eventrule_config_command 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, "eventrule_config_command":[{
"protocol":<String_value>,
"index":<Integer_value>,
"parent_name":<String_value>,
"timeout":<Integer_value>,
"nitro_payload":<String_value>,
"nitro_resource":<String_value>,
"id":<String_value>,
"nitro_method":<String_value>,
"command":<String_value>,
"parent_id":<String_value>}]}

<!--NeedCopy-->
eventrule_config_command
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.