Citrix ADC 12.1 NITRO API Reference

sslcipher_service_binding

Binding object showing the service that can be bound to sslcipher.

Properties

(click to see Operations)

Name Data Type Permissions Description
cipherpriority Read-write Priority of the cipher to be added.
Minimum value = 1
Maximum value = 1000
ciphgrpals Read-write A cipher-suite can consist of an individual cipher name, the system predefined cipher-alias name, or user defined cipher-group name.
Minimum length = 1
servicegroupname Read-write The name of the SSL service name to which the cipher-suite is to be bound.
Minimum length = 1
servicegroup Read-write Indicates that the cipher operation is to be performed on the named SSL service or service group.
service Read-write Indicates that the cipher operation is to be performed on the named SSL service or service group.
servicename Read-write The name of the SSL service name to which the cipher-suite is to be bound.
Minimum length = 1
ciphergroupname Read-write Name of the user-defined cipher group.
Minimum length = 1
cipheroperation Read-write The operation that is performed when adding the cipher-suite. Possible cipher operations are: ADD - Appends the given cipher-suite to the existing one configured for the virtual server. REM - Removes the given cipher-suite from the existing one configured for the virtual server. ORD - Overrides the current configured cipher-suite for the virtual server with the given cipher-suite.
Default value: 0
Possible values = ADD, REM, ORD

Operations

(click to see Properties)

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>.

sslcipher_service_binding