NetScaler SDX 13.1 NITRO API Reference

ca_sps_init_config

March 20, 2024

Contributed by:

Configuration for Initial Configuration Parameters of ca_sps resource.

Properties

(click to see Operations )

Name	Permissions	Description
master_key_password	Read-write	Default Master Key Password.
fips_mode	Read-write	This parameter defines whether the Policy Server we register a trusted host registration with is using FIPS mode or a non-FIPS mode.
enable_shared_secret_rollover	Read-write	This parameter lets you change the shared secret that the CA SiteMinder Policy Server uses to encrypt communications to the SPS Agents..
policy_svr_ip	Read-write	Policy Server IP address.
host_config_obj_name	Read-write	Admin profile Password of Websense Protector instance.
parent_id	Read-write	.
agent_name	Read-write	Agent Name.
enable_fed_gateway	Read-write	This parameter defines whether you want this CA SiteMinder SPS instance to act as a Federation Gateway..
id	Read-write	.
parent_name	Read-write	.
admin_reg_name	Read-write	Admin Reg Name.
agent_config_obj_name	Read-write	Agent Configuration Object Name.
trusted_host_name	Read-write	Trusted Host name which will be used to uniquely identify this CA SiteMinder SPS instance.
enable_webagent_result	Read-write	This parameter defines whether you want this CA SiteMinder SPS instance to act as a Web Agent..
apache_svr_name	Read-write	APACHE Server Name.
admin_reg_password	Read-write	Admin Reg Password.

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

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

ca_sps_init_config

March 20, 2024

Contributed by:

March 20, 2024

Contributed by:

ca_sps_init_config

Properties

Operations

In this article