filesystemencryption

Last published : Oct 30, 2026
Configuration for File System Encryption Information resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
ntimes0flash <Integer> Read-write Number of times /flash directory has to be written with 0s.
Default value: 0
Minimum value = 0
Maximum value = 16
ntimes0var <Integer> Read-write Number of times /var directory has to be written with 0s.
Default value: 0
Minimum value = 0
Maximum value = 16
passphrase <String> Read-write Encryption Passphrase.
Minimum length = 1
Maximum length = 512
nodeid <Integer> Read-write Unique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
supportedstate <String> Read-only Get the supported state of File System Encryption.
Default value: 0
Possible values = DISABLED, ENABLED, ELIGIBLE
effectivestate <String> Read-only Get the current encrypted state of the File System.
Possible values = ENABLED, DISABLED
_nextgenapiresource <String> Read-only .

Operations

(click to see Properties )
  • ENABLE
  • DISABLE
  • 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

enable

URL: http:// <netscaler-ip-address> /nitro/v1/config/filesystemencryption? action=enable HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"filesystemencryption":{
<b>"ntimes0flash":<Integer_value>,
</b><b>"ntimes0var":<Integer_value>,
</b><b>"passphrase":<String_value>
</b>}}
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

disable

URL: http:// <netscaler-ip-address> /nitro/v1/config/filesystemencryption? action=disable HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"filesystemencryption":{
<b>"ntimes0flash":<Integer_value>,
</b><b>"ntimes0var":<Integer_value>,
</b><b>"passphrase":<String_value>
</b>}}
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/filesystemencryption Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/filesystemencryption? args=nodeid: <Integer_value>
Use this query-parameter to get filesystemencryption resources based on additional properties.
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:
{ "filesystemencryption": [ {
nodeid:<Integer_value>"supportedstate":<String_value>,
"effectivestate":<String_value>,
"_nextgenapiresource":<String_value>
}]}