ADC NITRO APIs

ipsecprofile

August 17, 2023

Contributed by:

Configuration for IPSEC profile resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
name		Read-write	The name of the ipsec profile. Minimum length = 1 Maximum length = 32
ikeversion		Read-write	IKE Protocol Version. Possible values = V1, V2
encalgo	<String[]>	Read-write	Type of encryption algorithm (Note: Selection of AES enables AES128). Possible values = AES, 3DES, AES192, AES256
hashalgo	<String[]>	Read-write	Type of hashing algorithm. Possible values = HMAC_SHA1, HMAC_SHA256, HMAC_SHA384, HMAC_SHA512, HMAC_MD5
lifetime		Read-write	Lifetime of IKE SA in seconds. Lifetime of IPSec SA will be (lifetime of IKE SA/8). Minimum value = 480 Maximum value = 31536000
psk		Read-write	Pre shared key value.
publickey		Read-write	Public key file path.
privatekey		Read-write	Private key file path.
peerpublickey		Read-write	Peer public key file path.
livenesscheckinterval		Read-write	Number of seconds after which a notify payload is sent to check the liveliness of the peer. Additional retries are done as per retransmit interval setting. Zero value disables liveliness checks. Minimum value = 0 Maximum value = 64999
replaywindowsize		Read-write	IPSec Replay window size for the data traffic. Minimum value = 0 Maximum value = 16384
ikeretryinterval		Read-write	IKE retry interval for bringing up the connection. Minimum value = 60 Maximum value = 3600
retransmissiontime		Read-write	The interval in seconds to retry sending the IKE messages to peer, three consecutive attempts are done with doubled interval after every failure. Minimum value = 1 Maximum value = 99
perfectforwardsecrecy		Read-write	Enable/Disable PFS. Possible values = ENABLE, DISABLE
responderonly		Read-only	Responder Only config for IKED. Possible values = YES, NO
builtin	<String[]>	Read-only	Indicates that a variable is a built-in (SYSTEM INTERNAL) type. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature		Read-only	The feature to be checked while applying this config.
__count		Read-only	count parameter

Operations

(click to see Properties )

ADD
GET (ALL)
GET
COUNT
DELETE

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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"ipsecprofile":{
<b>      "name":<String_value>,
</b>      "ikeversion":<String_value>,
      "encalgo":<String[]_value>,
      "hashalgo":<String[]_value>,
      "lifetime":<Double_value>,
      "psk":<String_value>,
      "publickey":<String_value>,
      "privatekey":<String_value>,
      "peerpublickey":<String_value>,
      "livenesscheckinterval":<Double_value>,
      "replaywindowsize":<Double_value>,
      "ikeretryinterval":<Double_value>,
      "retransmissiontime":<Double_value>,
      "perfectforwardsecrecy":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile/ name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of ipsecprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile? view=summary

Use this query-parameter to get the summary output of ipsecprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile? pagesize=#no;pageno=#no

Use this query-parameter to get the ipsecprofile resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "ipsecprofile": [ {
      "name":<String_value>,
      "ikeversion":<String_value>,
      "encalgo":<String[]_value>,
      "hashalgo":<String[]_value>,
      "lifetime":<Double_value>,
      "livenesscheckinterval":<Double_value>,
      "replaywindowsize":<Double_value>,
      "retransmissiontime":<Double_value>,
      "psk":<String_value>,
      "publickey":<String_value>,
      "privatekey":<String_value>,
      "peerpublickey":<String_value>,
      "ikeretryinterval":<Double_value>,
      "perfectforwardsecrecy":<String_value>,
      "responderonly":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of ipsecprofile resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "ipsecprofile": [ {
      "name":<String_value>,
      "ikeversion":<String_value>,
      "encalgo":<String[]_value>,
      "hashalgo":<String[]_value>,
      "lifetime":<Double_value>,
      "livenesscheckinterval":<Double_value>,
      "replaywindowsize":<Double_value>,
      "retransmissiontime":<Double_value>,
      "psk":<String_value>,
      "publickey":<String_value>,
      "privatekey":<String_value>,
      "peerpublickey":<String_value>,
      "ikeretryinterval":<Double_value>,
      "perfectforwardsecrecy":<String_value>,
      "responderonly":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/ipsecprofile? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "ipsecprofile": [ { "__count": "#no"} ] }

<!--NeedCopy-->

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

ipsecprofile

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

ipsecprofile

Properties

Operations

add

delete

get (all)

get

count

In this article