public class ns extends vm_device
SESSION_NOT_EXISTS| Constructor and Description |
|---|
ns() |
| Modifier and Type | Method and Description |
|---|---|
static ns |
add(nitro_service client,
ns resource)
Use this operation to add NetScaler Instance.
|
static ns[] |
add(nitro_service client,
ns[] resources)
Use this operation to add NetScaler Instance in bulk.
|
static long |
count_filtered(nitro_service service,
filtervalue[] filter)
Use this API to count the filtered set of ns resources.
|
static long |
count_filtered(nitro_service service,
String filter)
Use this API to count the filtered set of ns resources.
|
static long |
count(nitro_service service)
Use this API to count the ns resources configured on NetScaler SDX.
|
static ns |
delete(nitro_service client,
ns resource)
Use this operation to delete NetScaler Instances.
|
static ns[] |
delete(nitro_service client,
ns[] resources)
Use this operation to delete NetScaler Instances in bulk.
|
static ns |
force_reboot(nitro_service client,
ns resource)
Use this operation to force reboot NetScaler Instance.
|
static ns[] |
force_reboot(nitro_service client,
ns[] resources)
Use this operation to force reboot NetScaler Instance in bulk.
|
static ns |
force_stop(nitro_service client,
ns resource)
Use this operation to force stop NetScaler Instance.
|
static ns[] |
force_stop(nitro_service client,
ns[] resources)
Use this operation to force stop NetScaler Instance in bulk.
|
String |
get_backplane()
Backplane Interface
|
String |
get_clip()
Cluster IPAddress
|
Integer |
get_clusterid()
Cluster Id
|
String |
get_cmd_policy()
true if you want to allow shell/sftp/scp access to NetScaler Instance administrator
|
String |
get_config_progress_status()
Config Progress Status
|
static ns[] |
get_filtered(nitro_service service,
filtervalue[] filter)
Use this API to fetch filtered set of ns resources.
|
static ns[] |
get_filtered(nitro_service service,
String filter)
Use this API to fetch filtered set of ns resources.
|
String |
get_ha_ip_address()
Peer IP Address of NetScaler Instance
|
String |
get_ha_master_state()
Master State (Primary/Secondary) of NetScaler Instance
|
String |
get_ha_sync()
The state of synchronization of NetScaler Instance
|
String |
get_health()
Node Health State
|
Double |
get_http_req()
HTTP Requests/second on NetScaler Instance
|
Boolean |
get_if_0_1()
Network 0/1 on VM Instance
|
Boolean |
get_if_0_2()
Network 0/2 on VM Instance
|
Boolean |
get_if_0_3()
Network 0/3 on VM Instance
|
Boolean |
get_iscco()
Is CCO
|
String |
get_license()
Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum)
|
protected base_resource[] |
get_nitro_bulk_response(nitro_service service,
String response)
Converts API response of bulk operation into object and returns the object array in case of get request.
|
protected base_resource[] |
get_nitro_response(nitro_service service,
String response)
Converts API response into object and returns the object array in case of get request.
|
String |
get_node_state()
Node State of NetScaler Instance
|
Integer |
get_nodeid()
Node Id
|
Double |
get_ns_cpu_usage()
CPU Usage (%) of NetScaler Instance
|
String |
get_ns_ip_address()
NS IP Address for this managed device
|
Double |
get_ns_memory_usage()
Memory Usage (%) of NetScaler Instance
|
Double |
get_ns_mgmt_cpu_usage()
Management CPU Usage (%) of NetScaler Instance
|
Double |
get_ns_rx()
In Throughput of NetScaler Instance in Mbps
|
Double |
get_ns_tx()
Out Throughput of NetScaler Instance in Mbps
|
Integer |
get_nsvlan_id()
VLAN Id
|
String[] |
get_nsvlan_interfaces()
VLAN Interfaces
|
Boolean |
get_nsvlan_tagged()
NSVLAN Tagged
|
Integer |
get_number_of_ssl_cores_up()
Number of SSL Cores Up
|
protected String |
get_object_id()
Returns the value of object identifier argument.
|
protected String |
get_object_type()
Gets the resource type.
|
String |
get_password()
Password for specified user on NetScaler Instance
|
String |
get_plugin_ip_address()
Signaling IP Address
|
Double |
get_pps()
Assign packets per seconds to NetScaler Instance
|
String |
get_state()
Node State
|
String |
get_upsince_persisted()
Upsince of NetScaler Instance
|
String |
get_upsince()
Upsince of NetScaler Instance
|
String |
get_username()
User Name (except nsroot) to be configured on NetScaler Instance
|
Integer |
get_vlan_type()
VLAN Type, NS or L2 VLAN
|
static ns[] |
get(nitro_service client)
Use this operation to get NetScaler Instance.
|
static ns |
get(nitro_service client,
ns resource)
Use this operation to get NetScaler Instance.
|
static ns |
reboot(nitro_service client,
ns resource)
Use this operation to reboot NetScaler Instance.
|
static ns[] |
reboot(nitro_service client,
ns[] resources)
Use this operation to reboot NetScaler Instance in bulk.
|
void |
set_backplane(String backplane)
Backplane Interface
|
void |
set_clip(String clip)
Cluster IPAddress
|
void |
set_clusterid(Integer clusterid)
Cluster Id
|
void |
set_cmd_policy(String cmd_policy)
true if you want to allow shell/sftp/scp access to NetScaler Instance administrator
|
void |
set_if_0_1(Boolean if_0_1)
Network 0/1 on VM Instance
|
void |
set_if_0_2(Boolean if_0_2)
Network 0/2 on VM Instance
|
void |
set_iscco(Boolean iscco)
Is CCO
|
void |
set_license(String license)
Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum)
|
void |
set_nodeid(Integer nodeid)
Node Id
|
void |
set_ns_ip_address(String ns_ip_address)
NS IP Address for this managed device
|
void |
set_nsvlan_id(Integer nsvlan_id)
VLAN Id
|
void |
set_nsvlan_interfaces(String[] nsvlan_interfaces)
VLAN Interfaces
|
void |
set_nsvlan_tagged(Boolean nsvlan_tagged)
NSVLAN Tagged
|
void |
set_number_of_ssl_cores_up(Integer number_of_ssl_cores_up)
Number of SSL Cores Up
|
void |
set_password(String password)
Password for specified user on NetScaler Instance
|
void |
set_plugin_ip_address(String plugin_ip_address)
Signaling IP Address
|
void |
set_pps(Double pps)
Assign packets per seconds to NetScaler Instance
|
void |
set_state(String state)
Node State
|
void |
set_username(String username)
User Name (except nsroot) to be configured on NetScaler Instance
|
void |
set_vlan_type(Integer vlan_type)
VLAN Type, NS or L2 VLAN
|
static ns |
start(nitro_service client,
ns resource)
Use this operation to start NetScaler Instance.
|
static ns[] |
start(nitro_service client,
ns[] resources)
Use this operation to start NetScaler Instance in bulk.
|
static ns |
stop(nitro_service client,
ns resource)
Use this operation to stop NetScaler Instance.
|
static ns[] |
stop(nitro_service client,
ns[] resources)
Use this operation to stop NetScaler Instance in bulk.
|
static ns |
update(nitro_service client,
ns resource)
Use this operation to modify NetScaler Instance.
|
static ns[] |
update(nitro_service client,
ns[] resources)
Use this operation to modify NetScaler Instance in bulk.
|
protected void |
validate(String operationType)
Performs generic data validation for the operation to be performed
|
get_assigned_cpu_socket, get_cpu_core_mgmt, get_cpu_core_pe, get_disk_allocation, get_disk_space, get_domain_name, get_domid, get_has_sdxtools, get_if_1_1, get_if_1_2, get_if_1_3, get_if_1_4, get_if_1_5, get_if_1_6, get_if_1_7, get_if_1_8, get_if_10_1, get_if_10_2, get_if_10_3, get_if_10_4, get_if_10_5, get_if_10_6, get_if_10_7, get_if_10_8, get_image_name, get_l2_enabled, get_la_mgmt, get_mac_eth0, get_network_interfaces, get_number_of_cores, get_number_of_ssl_cores, get_preferred_cpu_socket, get_provision_with_xva, get_reboot_vm_on_cpu_change, get_receiveuntagged_1_1, get_receiveuntagged_1_2, get_receiveuntagged_1_3, get_receiveuntagged_1_4, get_receiveuntagged_1_5, get_receiveuntagged_1_6, get_receiveuntagged_1_7, get_receiveuntagged_1_8, get_receiveuntagged_10_1, get_receiveuntagged_10_2, get_receiveuntagged_10_3, get_receiveuntagged_10_4, get_receiveuntagged_10_5, get_receiveuntagged_10_6, get_receiveuntagged_10_7, get_receiveuntagged_10_8, get_sdxtools_http_port, get_sdxtools_public_key, get_sdxtools_version, get_ssl_virtual_functions, get_sync_operation, get_template_name, get_throughput, get_uptime, get_uuid, get_virtual_functions, get_vlan_1_1, get_vlan_1_2, get_vlan_1_3, get_vlan_1_4, get_vlan_1_5, get_vlan_1_6, get_vlan_1_7, get_vlan_1_8, get_vlan_10_1, get_vlan_10_2, get_vlan_10_3, get_vlan_10_4, get_vlan_10_5, get_vlan_10_6, get_vlan_10_7, get_vlan_10_8, get_vlan_id_0_1, get_vlan_id_0_2, get_vm_cpu_usage, get_vm_description, get_vm_memory_free, get_vm_memory_total, get_vm_memory_usage, get_vm_rx, get_vm_state, get_vm_tx, get_vrid_list_ipv4_1_1, get_vrid_list_ipv4_1_2, get_vrid_list_ipv4_1_3, get_vrid_list_ipv4_1_4, get_vrid_list_ipv4_1_5, get_vrid_list_ipv4_1_6, get_vrid_list_ipv4_1_7, get_vrid_list_ipv4_1_8, get_vrid_list_ipv4_10_1, get_vrid_list_ipv4_10_2, get_vrid_list_ipv4_10_3, get_vrid_list_ipv4_10_4, get_vrid_list_ipv4_10_5, get_vrid_list_ipv4_10_6, get_vrid_list_ipv4_10_7, get_vrid_list_ipv4_10_8, get_vrid_list_ipv6_1_1, get_vrid_list_ipv6_1_2, get_vrid_list_ipv6_1_3, get_vrid_list_ipv6_1_4, get_vrid_list_ipv6_1_5, get_vrid_list_ipv6_1_6, get_vrid_list_ipv6_1_7, get_vrid_list_ipv6_1_8, get_vrid_list_ipv6_10_1, get_vrid_list_ipv6_10_2, get_vrid_list_ipv6_10_3, get_vrid_list_ipv6_10_4, get_vrid_list_ipv6_10_5, get_vrid_list_ipv6_10_6, get_vrid_list_ipv6_10_7, get_vrid_list_ipv6_10_8, get, set_domain_name, set_if_1_1, set_if_1_2, set_if_1_3, set_if_1_4, set_if_1_5, set_if_1_6, set_if_1_7, set_if_1_8, set_if_10_1, set_if_10_2, set_if_10_3, set_if_10_4, set_if_10_5, set_if_10_6, set_if_10_7, set_if_10_8, set_image_name, set_l2_enabled, set_la_mgmt, set_network_interfaces, set_number_of_cores, set_number_of_ssl_cores, set_provision_with_xva, set_reboot_vm_on_cpu_change, set_receiveuntagged_1_1, set_receiveuntagged_1_2, set_receiveuntagged_1_3, set_receiveuntagged_1_4, set_receiveuntagged_1_5, set_receiveuntagged_1_6, set_receiveuntagged_1_7, set_receiveuntagged_1_8, set_receiveuntagged_10_1, set_receiveuntagged_10_2, set_receiveuntagged_10_3, set_receiveuntagged_10_4, set_receiveuntagged_10_5, set_receiveuntagged_10_6, set_receiveuntagged_10_7, set_receiveuntagged_10_8, set_sync_operation, set_template_name, set_throughput, set_vlan_1_1, set_vlan_1_2, set_vlan_1_3, set_vlan_1_4, set_vlan_1_5, set_vlan_1_6, set_vlan_1_7, set_vlan_1_8, set_vlan_10_1, set_vlan_10_2, set_vlan_10_3, set_vlan_10_4, set_vlan_10_5, set_vlan_10_6, set_vlan_10_7, set_vlan_10_8, set_vlan_id_0_1, set_vlan_id_0_2, set_vm_memory_total, set_vrid_list_ipv4_1_1, set_vrid_list_ipv4_1_2, set_vrid_list_ipv4_1_3, set_vrid_list_ipv4_1_4, set_vrid_list_ipv4_1_5, set_vrid_list_ipv4_1_6, set_vrid_list_ipv4_1_7, set_vrid_list_ipv4_1_8, set_vrid_list_ipv4_10_1, set_vrid_list_ipv4_10_2, set_vrid_list_ipv4_10_3, set_vrid_list_ipv4_10_4, set_vrid_list_ipv4_10_5, set_vrid_list_ipv4_10_6, set_vrid_list_ipv4_10_7, set_vrid_list_ipv4_10_8, set_vrid_list_ipv6_1_1, set_vrid_list_ipv6_1_2, set_vrid_list_ipv6_1_3, set_vrid_list_ipv6_1_4, set_vrid_list_ipv6_1_5, set_vrid_list_ipv6_1_6, set_vrid_list_ipv6_1_7, set_vrid_list_ipv6_1_8, set_vrid_list_ipv6_10_1, set_vrid_list_ipv6_10_2, set_vrid_list_ipv6_10_3, set_vrid_list_ipv6_10_4, set_vrid_list_ipv6_10_5, set_vrid_list_ipv6_10_6, set_vrid_list_ipv6_10_7, set_vrid_list_ipv6_10_8add, add, delete, delete, get_act_id, get_description, get_device_family, get_gateway, get_hostname, get_id, get_instance_state, get_ip_address, get_name, get_netmask, get_ping_state, get_profile_name, get_profile_password, get_profile_username, get_reason, get_status, get_type, get_user_driven, get_version, set_description, set_device_family, set_gateway, set_hostname, set_id, set_ip_address, set_name, set_netmask, set_profile_name, set_profile_password, set_profile_username, set_typeadd_resource, add_resource, delete_bulk_request, delete_resource, get_resource, get_resource, get_resources, get_resources, getfiltered, perform_operation_bulk_request, perform_operation, perform_operation, perform_operation, resource_to_string, resource_to_string, update_bulk_request, update_resource, update_resourceprotected String get_object_type()
base_resourceget_object_type in class vm_deviceprotected String get_object_id()
get_object_id in class vm_devicepublic void set_if_0_2(Boolean if_0_2)
Network 0/2 on VM Instance
public Boolean get_if_0_2()
Network 0/2 on VM Instance
public Boolean get_if_0_3()
Network 0/3 on VM Instance
public void set_backplane(String backplane)
Backplane Interface
public String get_backplane()
Backplane Interface
public void set_clusterid(Integer clusterid)
Cluster Id
public Integer get_clusterid()
Cluster Id
public void set_nodeid(Integer nodeid)
Node Id
public Integer get_nodeid()
Node Id
public void set_if_0_1(Boolean if_0_1)
Network 0/1 on VM Instance
public Boolean get_if_0_1()
Network 0/1 on VM Instance
public void set_state(String state)
Node State
public String get_state()
Node State
public void set_ns_ip_address(String ns_ip_address)
NS IP Address for this managed device
public String get_ns_ip_address()
NS IP Address for this managed device
public void set_password(String password)
Password for specified user on NetScaler Instance
public String get_password()
Password for specified user on NetScaler Instance
public String get_ha_master_state()
Master State (Primary/Secondary) of NetScaler Instance
public String get_upsince_persisted()
Upsince of NetScaler Instance
public Double get_http_req()
HTTP Requests/second on NetScaler Instance
public String get_ha_sync()
The state of synchronization of NetScaler Instance
public String get_ha_ip_address()
Peer IP Address of NetScaler Instance
public void set_username(String username)
User Name (except nsroot) to be configured on NetScaler Instance
public String get_username()
User Name (except nsroot) to be configured on NetScaler Instance
public Double get_ns_cpu_usage()
CPU Usage (%) of NetScaler Instance
public String get_upsince()
Upsince of NetScaler Instance
public Double get_ns_rx()
In Throughput of NetScaler Instance in Mbps
public String get_node_state()
Node State of NetScaler Instance
public void set_plugin_ip_address(String plugin_ip_address)
Signaling IP Address
public String get_plugin_ip_address()
Signaling IP Address
public void set_vlan_type(Integer vlan_type)
VLAN Type, NS or L2 VLAN
public Integer get_vlan_type()
VLAN Type, NS or L2 VLAN
public void set_nsvlan_id(Integer nsvlan_id)
VLAN Id
public Integer get_nsvlan_id()
VLAN Id
public void set_cmd_policy(String cmd_policy)
true if you want to allow shell/sftp/scp access to NetScaler Instance administrator
public String get_cmd_policy()
true if you want to allow shell/sftp/scp access to NetScaler Instance administrator
public void set_iscco(Boolean iscco)
Is CCO
public Boolean get_iscco()
Is CCO
public Double get_ns_memory_usage()
Memory Usage (%) of NetScaler Instance
public void set_nsvlan_tagged(Boolean nsvlan_tagged)
NSVLAN Tagged
public Boolean get_nsvlan_tagged()
NSVLAN Tagged
public void set_clip(String clip)
Cluster IPAddress
public String get_clip()
Cluster IPAddress
public Double get_ns_mgmt_cpu_usage()
Management CPU Usage (%) of NetScaler Instance
public void set_pps(Double pps)
Assign packets per seconds to NetScaler Instance
public Double get_pps()
Assign packets per seconds to NetScaler Instance
public String get_health()
Node Health State
public void set_license(String license)
Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum)
public String get_license()
Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum)
public Double get_ns_tx()
Out Throughput of NetScaler Instance in Mbps
public String get_config_progress_status()
Config Progress Status
public void set_number_of_ssl_cores_up(Integer number_of_ssl_cores_up)
Number of SSL Cores Up
public Integer get_number_of_ssl_cores_up()
Number of SSL Cores Up
public void set_nsvlan_interfaces(String[] nsvlan_interfaces)
VLAN Interfaces
public String[] get_nsvlan_interfaces()
VLAN Interfaces
public static ns reboot(nitro_service client, ns resource) throws Exception
Exceptionpublic static ns[] reboot(nitro_service client, ns[] resources) throws Exception
Use this operation to reboot NetScaler Instance in bulk.
Exceptionpublic static ns stop(nitro_service client, ns resource) throws Exception
Exceptionpublic static ns[] stop(nitro_service client, ns[] resources) throws Exception
Use this operation to stop NetScaler Instance in bulk.
Exceptionpublic static ns add(nitro_service client, ns resource) throws Exception
Use this operation to add NetScaler Instance.
Exceptionpublic static ns[] add(nitro_service client, ns[] resources) throws Exception
Use this operation to add NetScaler Instance in bulk.
Exceptionpublic static ns force_reboot(nitro_service client, ns resource) throws Exception
Exceptionpublic static ns[] force_reboot(nitro_service client, ns[] resources) throws Exception
Use this operation to force reboot NetScaler Instance in bulk.
Exceptionpublic static ns[] get(nitro_service client) throws Exception
Use this operation to get NetScaler Instance.
Exceptionpublic static ns get(nitro_service client, ns resource) throws Exception
Exceptionpublic static ns delete(nitro_service client, ns resource) throws Exception
Use this operation to delete NetScaler Instances.
Exceptionpublic static ns[] delete(nitro_service client, ns[] resources) throws Exception
Use this operation to delete NetScaler Instances in bulk.
Exceptionpublic static ns update(nitro_service client, ns resource) throws Exception
Use this operation to modify NetScaler Instance.
Exceptionpublic static ns[] update(nitro_service client, ns[] resources) throws Exception
Use this operation to modify NetScaler Instance in bulk.
Exceptionpublic static ns force_stop(nitro_service client, ns resource) throws Exception
Exceptionpublic static ns[] force_stop(nitro_service client, ns[] resources) throws Exception
Use this operation to force stop NetScaler Instance in bulk.
Exceptionpublic static ns start(nitro_service client, ns resource) throws Exception
Exceptionpublic static ns[] start(nitro_service client, ns[] resources) throws Exception
Use this operation to start NetScaler Instance in bulk.
Exceptionpublic static ns[] get_filtered(nitro_service service, String filter) throws Exception
Exceptionpublic static ns[] get_filtered(nitro_service service, filtervalue[] filter) throws Exception
Exceptionpublic static long count(nitro_service service) throws Exception
Exceptionpublic static long count_filtered(nitro_service service, String filter) throws Exception
Exceptionpublic static long count_filtered(nitro_service service, filtervalue[] filter) throws Exception
Exceptionprotected base_resource[] get_nitro_response(nitro_service service, String response) throws Exception
Converts API response into object and returns the object array in case of get request.
get_nitro_response in class vm_deviceExceptionprotected base_resource[] get_nitro_bulk_response(nitro_service service, String response) throws Exception
Converts API response of bulk operation into object and returns the object array in case of get request.
get_nitro_bulk_response in class vm_deviceExceptionCopyright © 2013 Citrix Systems, Inc.. All Rights Reserved.