Product Documentation

ns

Jun 02, 2016

NetScaler

do stop show do start do reboot delete set do force_reboot add do force_stop

do ns stop

Use this operation to stop NetScaler Instance

Synopsys

do ns stop [id=<string>]

Parameters

id

Id is system generated key for all the NetScaler Instances

show ns

Use this operation to get NetScaler Instance

Synopsys

show ns [id=<string>] [name=<string>]

Parameters

id

Id is system generated key for all the NetScaler Instances

name

Name of managed device

do ns start

Use this operation to start NetScaler Instance

Synopsys

do ns start [id=<string>]

Parameters

id

Id is system generated key for all the NetScaler Instances

do ns reboot

Use this operation to reboot NetScaler Instance

Synopsys

do ns reboot [id=<string>]

Parameters

id

Id is system generated key for all the NetScaler Instances

delete ns

Use this operation to delete NetScaler Instances

Synopsys

delete ns id=<string>

Parameters

id

Id is system generated key for all the NetScaler Instances

This is a mandatory parameter.

set ns

Use this operation to modify NetScaler Instance

Synopsys

set ns id=<string> [name=<string>] [ip_address=<ipaddress>] [netmask=<ipaddress>] [gateway=<ipaddress>] [license=<string>] [admin_profile_name=<string>] [description=<string>] [vm_memory_total=<doublelong>] [num_of_ssl_chips=<int>] [throughput=<doublelong>] [pps=<doublelong>] [number_of_cores=<int>] [reboot_vm_on_cpu_change=(false true)] [password=<stringx>] [cmd_policy=<string>] [l2_enabled=(false true)] [if_0_1=(false true)] [if_0_2=(false true)] [la_mgmt=(false true)] [vlan_id_0_1=<int>] [vlan_id_0_2=<int>] [network_interfaces=<network_interface…>] [nsvlan_id=<int>] [vlan_type=<int>] [nsvlan_tagged=(false true)] [nsvlan_interfaces=<string…>]

Parameters

id

Id is system generated key for all the NetScaler Instances

This is a mandatory parameter.

name

Name of managed device

ip_address

IP Address for this managed device

netmask

Netmask of managed device

gateway

Default Gateway of managed device

license

Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum)

admin_profile_name

Device Profile Name that is attached with this managed device

description

Description of managed device

vm_memory_total

Total Memory of VM Instance in MB

num_of_ssl_chips

Assign number of ssl virtual functions to VM Instance

throughput

Assign throughput in Mbps to VM Instance

pps

Assign packets per seconds to NetScaler Instance

number_of_cores

Number of cores that are assigned to VM Instance

reboot_vm_on_cpu_change

Reboot VMs on CPU change during resource allocation

password

Password for specified user on NetScaler Instance

cmd_policy

true if you want to allow shell/sftp/scp access to NetScaler Instance administrator

l2_enabled

L2mode status of VM Instance

if_0_1

Network 0/1 on VM Instance

if_0_2

Network 0/2 on VM Instance

la_mgmt

Bond consisting of management ports on VM Instance

vlan_id_0_1

VLAN id for the management interface 0/1

vlan_id_0_2

VLAN id for the management interface 0/2

network_interfaces

Network Interfaces

nsvlan_id

VLAN Id

vlan_type

VLAN Type, NS or L2 VLAN

nsvlan_tagged

NSVLAN Tagged

nsvlan_interfaces

VLAN Interfaces

do ns force_reboot

Use this operation to force reboot NetScaler Instance

Synopsys

do ns force_reboot [id=<string>]

Parameters

id

Id is system generated key for all the NetScaler Instances

add ns

Use this operation to add NetScaler Instance

Synopsys

add ns ip_address=<ipaddress> [gateway=<ipaddress>] [l2_enabled=(false true)] [nsvlan_interfaces=<string…>] [pps=<doublelong>] [throughput=<doublelong>] [la_mgmt=(false true)] [nsvlan_tagged=(false true)] [license=<string>] [username=<string>] [cmd_policy=<string>] [name=<string>] [number_of_cores=<int>] [vlan_id_0_1=<int>] [if_0_1=(false true)] [netmask=<ipaddress>] [vlan_id_0_2=<int>] [description=<string>] [if_0_2=(false true)] [network_interfaces=<network_interface…>] [reboot_vm_on_cpu_change=(false true)] [vlan_type=<int>] [xva_file_name=<string>] [password=<stringx>] [vm_memory_total=<doublelong>] [nsvlan_id=<int>]

Parameters

ip_address

IP Address for this managed device

This is a mandatory parameter.

gateway

Default Gateway of managed device

l2_enabled

L2mode status of VM Instance

nsvlan_interfaces

VLAN Interfaces

pps

Assign packets per seconds to NetScaler Instance

throughput

Assign throughput in Mbps to VM Instance

la_mgmt

Bond consisting of management ports on VM Instance

nsvlan_tagged

NSVLAN Tagged

license

Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum)

username

User Name (except nsroot) to be configured on NetScaler Instance

cmd_policy

true if you want to allow shell/sftp/scp access to NetScaler Instance administrator

name

Name of managed device

number_of_cores

Number of cores that are assigned to VM Instance

vlan_id_0_1

VLAN id for the management interface 0/1

if_0_1

Network 0/1 on VM Instance

netmask

Netmask of managed device

vlan_id_0_2

VLAN id for the management interface 0/2

description

Description of managed device

if_0_2

Network 0/2 on VM Instance

network_interfaces

Network Interfaces

reboot_vm_on_cpu_change

Reboot VMs on CPU change during resource allocation

vlan_type

VLAN Type, NS or L2 VLAN

xva_file_name

Image Name, This parameter is used while provisioning VM Instance with XVA image, template_name is given priority if provided along with image_name

password

Password for specified user on NetScaler Instance

vm_memory_total

Total Memory of VM Instance in MB

nsvlan_id

VLAN Id

do ns force_stop

Use this operation to force stop NetScaler Instance

Synopsys

do ns force_stop [id=<string>]

Parameters

id

Id is system generated key for all the NetScaler Instances