utility

Documentation

Index

• type Callhome
• type Install
• type Ping
• type Ping6
• type Raid
• type Techsupport
• type Traceroute
• type Traceroute6

Types

type Callhome

type Callhome struct {
	/**
	* Unique number that identifies the cluster node.
	 */
	Nodeid int `json:"nodeid,omitempty"`
	/**
	* CallHome mode of operation
	 */
	Mode string `json:"mode,omitempty"`
	/**
	* Email address of the contact administrator.
	 */
	Emailaddress string `json:"emailaddress,omitempty"`
	/**
	* Interval (in days) between CallHome heartbeats
	 */
	Hbcustominterval int `json:"hbcustominterval,omitempty"`
	/**
	* Enables or disables the proxy mode. The proxy server can be set by either specifying the IP address of the server or the name of the service representing the proxy server.
	 */
	Proxymode string `json:"proxymode,omitempty"`
	/**
	* IP address of the proxy server.
	 */
	Ipaddress string `json:"ipaddress,omitempty"`
	/**
	* Name of the service that represents the proxy server.
	 */
	Proxyauthservice string `json:"proxyauthservice,omitempty"`
	/**
	* HTTP port on the Proxy server. This is a mandatory parameter for both IP address and service name based configuration.
	 */
	Port int `json:"port,omitempty"`

	Sslcardfirstfailure  string `json:"sslcardfirstfailure,omitempty"`
	Sslcardlatestfailure string `json:"sslcardlatestfailure,omitempty"`
	Powfirstfail         string `json:"powfirstfail,omitempty"`
	Powlatestfailure     string `json:"powlatestfailure,omitempty"`
	Hddfirstfail         string `json:"hddfirstfail,omitempty"`
	Hddlatestfailure     string `json:"hddlatestfailure,omitempty"`
	Flashfirstfail       string `json:"flashfirstfail,omitempty"`
	Flashlatestfailure   string `json:"flashlatestfailure,omitempty"`
	Rlfirsthighdrop      string `json:"rlfirsthighdrop,omitempty"`
	Rllatesthighdrop     string `json:"rllatesthighdrop,omitempty"`
	Restartlatestfail    string `json:"restartlatestfail,omitempty"`
	Memthrefirstanomaly  string `json:"memthrefirstanomaly,omitempty"`
	Memthrelatestanomaly string `json:"memthrelatestanomaly,omitempty"`
	Callhomestatus       string `json:"callhomestatus,omitempty"`
}

* * Configuration for callhome resource.

type Install

type Install struct {
	/**
	* Url for the build file. Must be in the following formats:
		http://[user]:[password]@host/path/to/file
		https://[user]:[password]@host/path/to/file
		sftp://[user]:[password]@host/path/to/file
		scp://[user]:[password]@host/path/to/file
		ftp://[user]:[password]@host/path/to/file
		file://path/to/file
	*/
	Url string `json:"url,omitempty"`
	/**
	* Do not prompt for yes/no before rebooting.
	 */
	Y bool `json:"y,omitempty"`
	/**
	* Use this flag to enable callhome.
	 */
	L bool `json:"l,omitempty"`
	/**
	* Use this flag to enable Citrix ADM Service Connect. This feature helps you discover your Citrix ADC instances effortlessly on Citrix ADM service and get insights and curated machine learning based recommendations for applications and Citrix ADC infrastructure. This feature lets the Citrix ADC instance automatically send system, usage and telemetry data to Citrix ADM service. View here [https://docs.citrix.com/en-us/citrix-adc/13/data-governance.html] to learn more about this feature. Use of this feature is subject to the Citrix End User ServiceAgreement. View here [https://www.citrix.com/buy/licensing/agreements.html].
	 */
	A bool `json:"a,omitempty"`
	/**
	* Use this flag for upgrading from/to enhancement mode.
	 */
	Enhancedupgrade bool `json:"enhancedupgrade,omitempty"`
	/**
	* Use this flag to change swap size on ONLY 64bit nCore/MCNS/VMPE systems NON-VPX systems.
	 */
	Resizeswapvar bool `json:"resizeswapvar,omitempty"`
}

type Ping

type Ping struct {
	/**
	* Number of packets to send. The default value is infinite. For Nitro API, defalut value is taken as 5.
	 */
	C int `json:"c,omitempty"`
	/**
	* Waiting time, in seconds. The default value is 1 second.
	 */
	I int `json:"i,omitempty"`
	/**
	* Network interface on which to ping, if you have multiple interfaces.
	 */
	I_ string `json:"I,omitempty"`
	/**
	* Numeric output only. No name resolution.
	 */
	N bool `json:"n,omitempty"`
	/**
	* Pattern to fill in packets.  Can be up to 16 bytes, useful for diagnosing data-dependent problems.
	 */
	P string `json:"p,omitempty"`
	/**
	* Quiet output. Only the summary is printed. For Nitro API, this flag is set by default.
	 */
	Q bool `json:"q,omitempty"`
	/**
	* Data size, in bytes. The default value is 56.
	 */
	S int `json:"s,omitempty"`
	/**
	* Source IP address to be used in the outgoing query packets. If the IP addrESS does not belongs to this appliance, an error is returned and nothing is sent.
	 */
	S_ string `json:"S,omitempty"`
	/**
	* Traffic Domain Id
	 */
	T int `json:"T,omitempty"`
	/**
	* Time-out, in seconds, before ping exits.
	 */
	T_ int `json:"t,omitempty"`
	/**
	* Address of host to ping.
	 */
	HostName string `json:"hostName,omitempty"`

	Response string `json:"response,omitempty"`
}

type Ping6

type Ping6 struct {
	/**
	* Set socket buffer size. If used, should be used with roughly +100 then the datalen (-s option). The default value is 8192.
	 */
	B int `json:"b,omitempty"`
	/**
	* Number of packets to send. The default value is infinite. For Nitro API, defalut value is taken as 5.
	 */
	C int `json:"c,omitempty"`
	/**
	* Waiting time, in seconds. The default value is 1 second.
	 */
	I int `json:"i,omitempty"`
	/**
	* Network interface on which to ping, if you have multiple interfaces.
	 */
	I_ string `json:"I,omitempty"`
	/**
	* By default, ping6 asks the kernel to fragment packets to fit into the minimum IPv6 MTU.The -m option will suppress the behavior for unicast packets.
	 */
	M bool `json:"m,omitempty"`
	/**
	* Numeric output only. No name resolution.
	 */
	N bool `json:"n,omitempty"`
	/**
	* Pattern to fill in packets. Can be up to 16 bytes, useful for diagnosing data-dependent problems.
	 */
	P string `json:"p,omitempty"`
	/**
	* Quiet output. Only summary is printed. For Nitro API, this flag is set by default
	 */
	Q bool `json:"q,omitempty"`
	/**
	* Data size, in bytes. The default value is 32.
	 */
	S int `json:"s,omitempty"`
	/**
	* VLAN ID for link local address.
	 */
	V int `json:"V,omitempty"`
	/**
	* Source IP address to be used in the outgoing query packets.
	 */
	S_ string `json:"S,omitempty"`
	/**
	* Traffic Domain Id
	 */
	T int `json:"T,omitempty"`
	/**
	* Timeout in seconds before ping6 exits
	 */
	T_ int `json:"t,omitempty"`
	/**
	* Address of host to ping.
	 */
	HostName string `json:"hostName,omitempty"`

	Response string `json:"response,omitempty"`
}

type Raid

type Raid struct {
}

* * Configuration for raid support resource.

type Techsupport

type Techsupport struct {
	/**
	* Use this option to gather data on the present node, all cluster nodes, or for the specified partitions. The CLUSTER scope generates smaller abbreviated archives for all nodes. The PARTITION scope collects the admin partition in addition to those specified. The partitionName option is only required for the PARTITION scope.
	 */
	Scope string `json:"scope,omitempty"`
	/**
	* Name of the partition
	 */
	Partitionname string `json:"partitionname,omitempty"`
	/**
	* Securely upload the collector archive to Citrix Technical Support using SSL. MyCitrix credentials will be required. If used with the -file option, no new collector archive is generated. Instead, the specified archive is uploaded. Note that the upload operation time depends on the size of the archive file, and the connection bandwidth.
	 */
	Upload bool `json:"upload,omitempty"`
	/**
	* Specifies the proxy server to be used when uploading a collector archive. Use this parameter if the Citrix ADC does not have direct internet connectivity. The basic format of the proxy string is: "proxy_IP:<proxy_port>" (without quotes). If the proxy requires authentication the format is: "username:password@proxy_IP:<proxy_port>"
	 */
	Proxy string `json:"proxy,omitempty"`
	/**
	* Specifies the associated case or service request number if it has already been opened with Citrix Technical Support.
	 */
	Casenumber string `json:"casenumber,omitempty"`
	/**
	* Specifies the name (with full path) of the collector archive file to be uploaded. If this is specified, no new collector archive is generated.
	 */
	File string `json:"file,omitempty"`
	/**
	* Provides a text description for the the upload, and can be used for logging purposes.
	 */
	Description string `json:"description,omitempty"`
	/**
	* Specifies My Citrix user name, which is used to login to Citrix upload server
	 */
	Username string `json:"username,omitempty"`
	/**
	* Specifies My Citrix password, which is used to login to Citrix upload server
	 */
	Password string `json:"password,omitempty"`

	Response   string `json:"response,omitempty"`
	Servername string `json:"servername,omitempty"`
}

* * Configuration for tech support resource.

type Traceroute

type Traceroute struct {
	/**
	* Print a summary of how many probes were not answered for each hop.
	 */
	S bool `json:"S,omitempty"`
	/**
	* Print hop addresses numerically instead of symbolically and numerically.
	 */
	N bool `json:"n,omitempty"`
	/**
	* Bypass normal routing tables and send directly to a host on an attached network. If the host is not on a directly attached network, an error is returned.
	 */
	R bool `json:"r,omitempty"`
	/**
	* Verbose output. List received ICMP packets other than TIME_EXCEEDED and UNREACHABLE.
	 */
	V bool `json:"v,omitempty"`
	/**
	* Minimum TTL value used in outgoing probe packets.
	 */
	M int `json:"M,omitempty"`
	/**
	* Maximum TTL value used in outgoing probe packets. For Nitro API, default value is taken as 10.
	 */
	M_ int `json:"m,omitempty"`
	/**
	* Send packets of specified IP protocol. The currently supported protocols are UDP and ICMP.
	 */
	P string `json:"P,omitempty"`
	/**
	* Base port number used in probes.
	 */
	P_ int `json:"p,omitempty"`
	/**
	* Number of queries per hop. For Nitro API, defalut value is taken as 1.
	 */
	Q int `json:"q,omitempty"`
	/**
	* Source IP address to use in the outgoing query packets. If the IP address does not belong to this appliance,  an error is returned and nothing is sent.
	 */
	S_ string `json:"s,omitempty"`
	/**
	* Traffic Domain Id
	 */
	T int `json:"T,omitempty"`
	/**
	* Type-of-service in query packets.
	 */
	T_ int `json:"t,omitempty"`
	/**
	* Time (in seconds) to wait for a response to a query. For Nitro API, defalut value is set to 3.
	 */
	W int `json:"w,omitempty"`
	/**
	* Destination host IP address or name.
	 */
	Host string `json:"host,omitempty"`
	/**
	* Length (in bytes) of the query packets.
	 */
	Packetlen int `json:"packetlen,omitempty"`

	Response string `json:"response,omitempty"`
}

type Traceroute6

type Traceroute6 struct {
	/**
	* Print hop addresses numerically rather than symbolically and numerically.
	 */
	N bool `json:"n,omitempty"`
	/**
	* Use ICMP ECHO for probes.
	 */
	I bool `json:"I,omitempty"`
	/**
	* Bypass normal routing tables and send directly to a host on an attached network. If the host is not on a directly attached network, an error is returned.
	 */
	R bool `json:"r,omitempty"`
	/**
	* Verbose output. List received ICMP packets other than TIME_EXCEEDED and UNREACHABLE.
	 */
	V bool `json:"v,omitempty"`
	/**
	* Maximum hop value for outgoing probe packets. For Nitro API, default value is taken as 10.
	 */
	M int `json:"m,omitempty"`
	/**
	* Base port number used in probes.
	 */
	P int `json:"p,omitempty"`
	/**
	* Number of probes per hop. For Nitro API, default value is taken as 1.
	 */
	Q int `json:"q,omitempty"`
	/**
	* Source IP address to use in the outgoing query packets. If the IP address does not belong to this appliance,  an error is returned and nothing is sent.
	 */
	S string `json:"s,omitempty"`
	/**
	* Traffic Domain Id
	 */
	T int `json:"T,omitempty"`
	/**
	* Time (in seconds) to wait for a response to a query. For Nitro API, defalut value is set to 3.
	 */
	W int `json:"w,omitempty"`
	/**
	* Destination host IP address or name.
	 */
	Host string `json:"host,omitempty"`
	/**
	* Length (in bytes) of the query packets.
	 */
	Packetlen int `json:"packetlen,omitempty"`

	Response string `json:"response,omitempty"`
}