Product Documentation

ns variable

Sep 12, 2016

The following operations can be performed on "ns variable":

add | set | unset | rm | show

add ns variable

Create a variable for use in assignments and default syntax expressions.

Synopsys

add ns variable <name> -type <string> [-scope ( global | transaction )] [-ifFull ( undef | lru )] [-ifValueTooBig ( undef | truncate )] [-ifNoValue ( undef | init )] [-init <string>] [-expires <positive_integer>] [-comment <string>]

Arguments

name

Variable name. This follows the same syntax rules as other default syntax expression entity names:

It must begin with an alpha character (A-Z or a-z) or an underscore (_).

The rest of the characters must be alpha, numeric (0-9) or underscores.

It cannot be re or xp (reserved for regular and XPath expressions).

It cannot be a default syntax expression reserved word (e.g. SYS or HTTP).

It cannot be used for an existing default syntax expression object (HTTP callout, patset, dataset, stringmap, or named expression).

type

Specification of the variable type; one of the following:

ulong - singleton variable with an unsigned 64-bit value.

text(value-max-size) - singleton variable with a text string value.

map(text(key-max-size),ulong,max-entries) - map of text string keys to unsigned 64-bit values.

map(text(key-max-size),text(value-max-size),max-entries) - map of text string keys to text string values.

where

value-max-size is a positive integer that is the maximum number of bytes in a text string value.

key-max-size is a positive integer that is the maximum number of bytes in a text string key.

max-entries is a positive integer that is the maximum number of entries in a map variable.

For a global singleton text variable, value-max-size <= 64000.

For a global map with ulong values, key-max-size <= 64000.

For a global map with text values, key-max-size + value-max-size <= 64000.

max-entries is a positive integer that is the maximum number of entries in a map variable. This has a theoretical maximum of 2^64-1, but in actual use will be much smaller, considering the memory available for use by the map.

Example:

map(text(10),text(20),100) specifies a map of text string keys (max size 10 bytes) to text string values (max size 20 bytes), with 100 max entries.

scope

Scope of the variable:

global - (default) one set of values visible across all Packet Engines and, in a cluster, all nodes

transaction - one value for each request-response transaction (singleton variables only; no expiration)

Possible values: global, transaction

Default value: global

ifFull

Action to perform if an assignment to a map exceeds its configured max-entries:

lru - (default) reuse the least recently used entry in the map.

undef - force the assignment to return an undefined (Undef) result to the policy executing the assignment.

Possible values: undef, lru

Default value: lru

ifValueTooBig

Action to perform if an value is assigned to a text variable that exceeds its configured max-size,

or if a key is used that exceeds its configured max-size:

truncate - (default) truncate the text string to the first max-size bytes and proceed.

undef - force the assignment or expression evaluation to return an undefined (Undef) result to the policy executing the assignment or expression.

Possible values: undef, truncate

Default value: truncate

ifNoValue

Action to perform if on a variable reference in an expression if the variable is single-valued and uninitialized

or if the variable is a map and there is no value for the specified key:

init - (default) initialize the single-value variable, or create a map entry for the key and the initial value,

using the -init value or its default.

undef - force the expression evaluation to return an undefined (Undef) result to the policy executing the expression.

Possible values: undef, init

Default value: init

init

Initialization value for values in this variable. Default: 0 for ulong, NULL for text

expires

Value expiration in seconds. If the value is not referenced within the expiration period it will be deleted. 0 (the default) means no expiration.

Minimum value: 0

Maximum value: 31622400

comment

Comments associated with this variable.

Example

add ns variable user_privilege_map -type map(text(15),text(10),10000)

set ns variable

Set a variable for use in assignments and default syntax expressions.

Synopsys

set ns variable <name> [-type <string>] [-ifFull ( undef | lru )] [-ifValueTooBig ( undef | truncate )] [-ifNoValue ( undef | init )] [-init <string>] [-expires <positive_integer>] [-comment <string>]

Arguments

name

Variable name. This follows the same syntax rules as other default syntax expression entity names:

It must begin with an alpha character (A-Z or a-z) or an underscore (_).

The rest of the characters must be alpha, numeric (0-9) or underscores.

It cannot be re or xp (reserved for regular and XPath expressions).

It cannot be a default syntax expression reserved word (e.g. SYS or HTTP).

It cannot be used for an existing default syntax expression object (HTTP callout, patset, dataset, stringmap, or named expression).

type

Specification of the variable type; one of the following:

ulong - singleton variable with an unsigned 64-bit value.

text(value-max-size) - singleton variable with a text string value.

map(text(key-max-size),ulong,max-entries) - map of text string keys to unsigned 64-bit values.

map(text(key-max-size),text(value-max-size),max-entries) - map of text string keys to text string values.

where

value-max-size is a positive integer that is the maximum number of bytes in a text string value.

key-max-size is a positive integer that is the maximum number of bytes in a text string key.

max-entries is a positive integer that is the maximum number of entries in a map variable.

For a global singleton text variable, value-max-size <= 64000.

For a global map with ulong values, key-max-size <= 64000.

For a global map with text values, key-max-size + value-max-size <= 64000.

max-entries is a positive integer that is the maximum number of entries in a map variable. This has a theoretical maximum of 2^64-1, but in actual use will be much smaller, considering the memory available for use by the map.

Example:

map(text(10),text(20),100) specifies a map of text string keys (max size 10 bytes) to text string values (max size 20 bytes), with 100 max entries.

ifFull

Action to perform if an assignment to a map exceeds its configured max-entries:

lru - (default) reuse the least recently used entry in the map.

undef - force the assignment to return an undefined (Undef) result to the policy executing the assignment.

Possible values: undef, lru

Default value: lru

ifValueTooBig

Action to perform if an value is assigned to a text variable that exceeds its configured max-size,

or if a key is used that exceeds its configured max-size:

truncate - (default) truncate the text string to the first max-size bytes and proceed.

undef - force the assignment or expression evaluation to return an undefined (Undef) result to the policy executing the assignment or expression.

Possible values: undef, truncate

Default value: truncate

ifNoValue

Action to perform if on a variable reference in an expression if the variable is single-valued and uninitialized

or if the variable is a map and there is no value for the specified key:

init - (default) initialize the single-value variable, or create a map entry for the key and the initial value,

using the -init value or its default.

undef - force the expression evaluation to return an undefined (Undef) result to the policy executing the expression.

Possible values: undef, init

Default value: init

init

Initialization value for values in this variable. Default: 0 for ulong, NULL for text

expires

Value expiration in seconds. If the value is not referenced within the expiration period it will be deleted. 0 (the default) means no expiration.

Minimum value: 0

Maximum value: 31622400

comment

Comments associated with this variable.

Example

set ns variable user_privilege_map -type map(text(15),text(10),10000)

unset ns variable

Use this command to remove ns variable settings.Refer to the set ns variable command for meanings of the arguments.

Synopsys

unset ns variable <name> [-ifFull] [-ifValueTooBig] [-ifNoValue] [-init] [-expires] [-comment]

rm ns variable

Remove a variable and its value(s).

Synopsys

rm ns variable <name>

Arguments

name

Variable name. This follows the same syntax rules as other default syntax expression entity names:

It must begin with an alpha character (A-Z or a-z) or an underscore (_).

The rest of the characters must be alpha, numeric (0-9) or underscores.

It cannot be re or xp (reserved for regular and XPath expressions).

It cannot be a default syntax expression reserved word (e.g. SYS or HTTP).

It cannot be used for an existing default syntax expression object (HTTP callout, patset, dataset, stringmap, or named expression).

Example

rm ns variable user_privilege_map

show ns variable

Display configured variables

Synopsys

show ns variable [<name>]

Arguments

name

Variable name. This follows the same syntax rules as other default syntax expression entity names:

It must begin with an alpha character (A-Z or a-z) or an underscore (_).

The rest of the characters must be alpha, numeric (0-9) or underscores.

It cannot be re or xp (reserved for regular and XPath expressions).

It cannot be a default syntax expression reserved word (e.g. SYS or HTTP).

It cannot be used for an existing default syntax expression object (HTTP callout, patset, dataset, stringmap, or named expression).

Outputs

type

Specification of the variable type; one of the following:

ulong - singleton variable with an unsigned 64-bit value.

text(value-max-size) - singleton variable with a text string value.

map(text(key-max-size),ulong,max-entries) - map of text string keys to unsigned 64-bit values.

map(text(key-max-size),text(value-max-size),max-entries) - map of text string keys to text string values.

where

value-max-size is a positive integer that is the maximum number of bytes in a text string value.

key-max-size is a positive integer that is the maximum number of bytes in a text string key.

max-entries is a positive integer that is the maximum number of entries in a map variable.

For a global singleton text variable, value-max-size <= 64000.

For a global map with ulong values, key-max-size <= 64000.

For a global map with text values, key-max-size + value-max-size <= 64000.

max-entries is a positive integer that is the maximum number of entries in a map variable. This has a theoretical maximum of 2^64-1, but in actual use will be much smaller, considering the memory available for use by the map.

Example:

map(text(10),text(20),100) specifies a map of text string keys (max size 10 bytes) to text string values (max size 20 bytes), with 100 max entries.

scope

Scope of the variable:

global - (default) one set of values visible across all Packet Engines and, in a cluster, all nodes

transaction - one value for each request-response transaction (singleton variables only; no expiration)

ifFull

Action to perform if an assignment to a map exceeds its configured max-entries:

lru - (default) reuse the least recently used entry in the map.

undef - force the assignment to return an undefined (Undef) result to the policy executing the assignment.

ifValueTooBig

Action to perform if an value is assigned to a text variable that exceeds its configured max-size,

or if a key is used that exceeds its configured max-size:

truncate - (default) truncate the text string to the first max-size bytes and proceed.

undef - force the assignment or expression evaluation to return an undefined (Undef) result to the policy executing the assignment or expression.

ifNoValue

Action to perform if on a variable reference in an expression if the variable is single-valued and uninitialized

or if the variable is a map and there is no value for the specified key:

init - (default) initialize the single-value variable, or create a map entry for the key and the initial value,

using the -init value or its default.

undef - force the expression evaluation to return an undefined (Undef) result to the policy executing the expression.

expires

Value expiration in seconds. If the value is not referenced within the expiration period it will be deleted. 0 (the default) means no expiration.

init

Initialization value for values in this variable. Default: 0 for ulong, NULL for text

comment

Comments associated with this variable.

builtin

Flag to determine if the variable is built-in or not

referenceCount

The number of references to the variable in expressions and assignments.

stateflag

devno

count