Monday, 5 February 2018

ONTAP Select - ONTAP Deploy 2.5 CLI Guide

There is an API guide but I couldn’t find a CLI guide (maybe I wasn’t looking hard enough) - which is an excuse to conjure up this post! Not the latest version but not too far off.

Version

Image: Logged into the ONTAP Deploy CLI


Shell Commands

cmdenvironment
ed
edit
help
hi
history
l
li
list
load
pause
py
r
run
save
set
shell
shortcuts
show


Undocumented Commands

EOF
eof
exit
q
quit


Application Commands

autosupport history
autosupport history-all
autosupport invoke
autosupport invoke-deploy-logs
autosupport invoke-host
autosupport manifest
autosupport modify
autosupport show
cluster create
cluster create-using-json
cluster delete
cluster offline
cluster online
cluster show
cluster show-all
configuration backup
configuration restore
deploy network info
event show-all
file delete
file list
help
host add
host configure
host remove
host show
host show-all
license add
license delete
license show
license show-all
mediator show
mediator show-all(ONTAPdeploy)
mediator-iscsi-target show
mediator-iscsi-target show-all
network connectivity-check cancel
network connectivity-check delete
network connectivity-check show
network connectivity-check show-all
network connectivity-check start
node console connect
node console disconnect
node coredump
node replace
node savecore
node show-all
node start
node stop
storage add
storage show-host
storage show-node
system config modify
system config show
upgrade
user password modify
version


Help Output: Shell Commands

(ONTAPdeploy) help cmdenvironment
Summary report of interactive parameters


(ONTAPdeploy) help ed / edit
ed: edit most recent command in text editor
ed [N]: edit numbered command from history
ed [filename]: edit specified file name
Commands are run after editor is closed. "set edit (program-name)" or set  EDITOR environment variable to control which editing program is used.


(ONTAPdeploy) help hi / history
history [arg]: lists past commands issued
 no arg: list all
 arg is integer: list one history item, by index
 arg is string: string search
 arg is /enclosed in forward-slashes/: regular expression search
Usage: history [options] (limit on which commands to include)
Options:
 -h, --help: show this help message and exit
 -s, --script: Script format; no separation lines


(ONTAPdeploy) help l / li / list
list [arg]: lists last command issued
 no arg -> list most recent command
 arg is integer -> list one history item, by index
 a..b, a:b, a:, ..b -> list spans from a (or start) to b (or end)
 arg is string -> list all commands matching string search
 arg is /enclosed in forward-slashes/ -> regular expression search


(ONTAPdeploy) help load
Runs script of command(s) from a file or URL.


(ONTAPdeploy) help pause
Displays the specified text then waits for the user to press RETURN.


(ONTAPdeploy) help py
py {command}: Executes a Python command.
py: Enters interactive Python mode.
End with ``Ctrl-D`` (Unix) / ``Ctrl-Z`` (Windows), ``quit()``, '`exit()``.
Non-python commands can be issued with ``cmd("your command")``.
Run python code from external files with ``run("filename.py")``


(ONTAPdeploy) help r / run
run [arg]: re-runs an earlier command
 no arg -> run most recent command
 arg is integer -> run one history item, by index
 arg is string -> run most recent command by string search
 arg is /enclosed in forward-slashes/ -> run most recent by regex


(ONTAPdeploy) help save
`save [N] [filename.ext]`
Saves command from history to file.
| N => Number of command (from history), or `*`;
|      most recent command if omitted


(ONTAPdeploy) help set
Sets a cmd2 parameter. Accepts abbreviated parameter names so long as there is no ambiguity.  Call without arguments for a list of settable parameters with their values.


(ONTAPdeploy) help shell
execute a command as if at the OS prompt.


(ONTAPdeploy) help shortcuts
Lists single-key shortcuts available


(ONTAPdeploy) help show
Shows value of a parameter.
Usage: show [options] arg
Options:
 -h, --help: show this help message and exit
 -l, --long: describe function of parameter


Help Output: Application Commands


COMMON optional arguments:
-h, --help: show this help message and exit


COMMON output formatter options:
 -f {csv,json,table,value,yaml}
 --format {csv,json,table,value,yaml}
  the output format, defaults to table
 -c COLUMN
 --column COLUMN
  specify the column(s) to include, can be repeated

table formatter:
 --max-width INTEGER
  Maximum display width, 0 to disable

json formatter:
 --noindent
  whether to disable indenting the JSON

CSV Formatter:
 --quote {all,minimal,none,nonnumeric}
  when to include quotes, defaults to nonnumeric

shell formatter:
 a format a UNIX shell can parse (variable="value")
 --prefix PREFIX
  add a prefix to all variable names



(ONTAPdeploy) help autosupport history
usage: autosupport history
--cluster-name CLUSTER_NAME

Return the history of up to the 50 most recent autosupports for a cluster.

Required arguments:
 --cluster-name CLUSTER_NAME


(ONTAPdeploy) help autosupport history-all
usage: autosupport history-all

Return the history of all autosupports


(ONTAPdeploy) help autosupport invoke
usage: autosupport invoke
--cluster-name CLUSTER_NAME
--node-name NODE_NAME
--invoke-type {troubleshooting,performance}
[--username USERNAME]
[--password PASSWORD]
[--case CASE]
[--message MESSAGE]

Invoke an autosupport specific to this node

Optional arguments:
 --username USERNAME
  Host root user name (ESX only)
 --password PASSWORD
  Password for the root user of the host (ESX only)
 --case CASE
  Case Number to include in the subject of the autosupport
 --message MESSAGE
  Note to appear in the subject of the autosupport

Required arguments:
 --cluster-name CLUSTER_NAME
 --node-name NODE_NAME
 --invoke-type {troubleshooting,performance}
  Type of the Autosupport


(ONTAPdeploy) help autosupport invoke-deploy-logs
usage: autosupport invoke-deploy-logs
[--case CASE]
[--message MESSAGE]

Invoke a DEPLOY_LOGS autosupport to collect local logs and state.

Optional arguments:
 --case CASE
  Case Number to include in the subject of the autosupport
 --message MESSAGE
  Note to appear in the subject of the autosupport


(ONTAPdeploy) help autosupport invoke-host
usage: autosupport invoke-host
--host-id HOST_ID
--invoke-type {troubleshooting,performance}
[--username USERNAME]
[--password PASSWORD]
[--case CASE]
[--message MESSAGE]

Invoke an autosupport specific to this host

Optional arguments:
 --username USERNAME
  Host root user name (ESX only)
 --password PASSWORD
  Password for the root user of the host (ESX only)
 --case CASE
  Case Number to include in the subject of the autosupport
 --message MESSAGE
  Note to appear in the subject of the autosupport

Required arguments:
 --host-id HOST_ID
  Name of the Host
 --invoke-type {troubleshooting,performance}
  Type of the Autosupport


(ONTAPdeploy) help autosupport manifest
usage: autosupport manifest
--seq-num SEQ_NUM

Get details about an Autosupport

Required arguments:
 --seq-num SEQ_NUM
  ID of the Autosupport


(ONTAPdeploy) help autosupport modify
usage: autosupport modify
[--asup-enabled {True,False}]
[--chunk-size CHUNK_SIZE]
[--destination-url DESTINATION_URL]
[--proxy-url PROXY_URL]
[--local-collection {True,False}]
[--retry-send-count RETRY_SEND_COUNT]
[--retry-send-interval RETRY_SEND_INTERVAL]
[--sender-threads SENDER_THREADS]
[--validate-digital-certificate {True,False}]
[--product-company PRODUCT_COMPANY]
[--product-site PRODUCT_SITE]

Replace the configuration for Autosupport.
Parameters are treated as optional. Unset parameters are not modified from current values. Set parameters replace
the previous values.

optional arguments:
 --asup-enabled {True,False}
  Toggle for the Autosupport feature
 --chunk-size CHUNK_SIZE
  Size of each transmission chunk in bytes
 --destination-url DESTINATION_URL
  HTTPs PUT URL to reach NetApp Autosupport server
 --proxy-url PROXY_URL
  Proxy authentication settings for HTTPS traffic on the local network.
  ('https://user:password@ip:port')
 --local-collection {True,False}
  Allows collection to local storage even if "asup_enabled"==false
 --retry-send-count RETRY_SEND_COUNT
  Max attempts to send an Autosupport
 --retry-send-interval RETRY_SEND_INTERVAL
  Seconds between Autosupport send retry attempts
 --sender-threads SENDER_THREADS
  Number of simultaneous sender tasks to allow
 --validate-digital-certificate {True,False}
  Enables hostname validation for digital certificates
 --product-company PRODUCT_COMPANY
  Descriptive string that represents the company or
  organization that runs this instance of ONTAPdeploy.
 --product-site PRODUCT_SITE
  Description of the location of this ONTAPdeploy instance


(ONTAPdeploy) help autosupport show
usage: autosupport show

Get the Autosupport Configuration


(ONTAPdeploy) help cluster create
usage: cluster create
--name NAME
[--admin-password ADMIN_PASSWORD]
--cluster-mgmt-ip CLUSTER_MGMT_IP
--netmask NETMASK
--gateway GATEWAY
[--ontap-image-version {9.2,9.1P2}]
[--node-names NODES_NAME [NODES_NAME ...]]
--node-mgmt-ips NODE_MGMT_IPS [NODE_MGMT_IPS ...]
--node-hosts NODES_HOST [NODES_HOST ...]
[--node-mirrors NODES_MIRROR [NODES_MIRROR ...]]
[--inhibit-rollback]
[--dns-ips DNS_IPS [DNS_IPS ...]]
[--dns-domains DNS_DOMAINS [DNS_DOMAINS ...]]
[--ntp-servers NTP_SERVERS [NTP_SERVERS ...]]

Create a new cluster
This will deploy an ONTAP Select cluster on the hosts provided. This command can take an extended period of time depending on the size of the storage pool to be consumed for ONTAP Select.
This version of the command accepts all the required parameters as command line arguments.

Optional arguments:
 --admin-password ADMIN_PASSWORD
  Password to set for the ONTAP admin user
 --ontap-image-version {9.2,9.1P2}
  The ONTAP Select version to use when deploying this cluster
 --node-names NODES_NAME [NODES_NAME ...]
  Space separated list of names to use for each node.
  If the list of node names is not included,
  ONTAP Deploy will autogenerate the node names.
  The node name can have a maximum length of 47 characters
  and use only alphanumeric characters and hyphens.
  Only ASCII-range characters are supported
 --node-mirrors NODES_MIRROR [NODES_MIRROR ...]
  Space separated list of the mirror of each node,
  the name of each mirror node is what is provided in this command.
  If this list is not included ONTAP Deploy will autogenerate the mirror mapping.
 --inhibit-rollback
  Do not cleanup on a cluster create failure,
  otherwise ONTAP Deploy will remove all record of the failed cluster.
 --dns-ips DNS_IPS [DNS_IPS ...]
  Space separated list of DNS IP addresses to be provided to ONTAP.
 --dns-domains DNS_DOMAINS [DNS_DOMAINS ...]
  Space separated list of DNS search domains to be provided to ONTAP.
 --ntp-servers NTP_SERVERS [NTP_SERVERS ...]
  Space separated list of NTP server addresses to be provided to ONTAP.

Required arguments:
 --name NAME
  Name of the cluster.
  The cluster name can have a maximum length of 44 characters.
  The name must start with an alphabetic character and
  contain only alphanumeric characters and hyphens.
  The following names are reserved by the system:
  'local, localhost,cluster'.
  Only ASCII-range characters are supported.
 --cluster-mgmt-ip CLUSTER_MGMT_IP
  IP address to use for Cluster Mgmt LIF
 --netmask NETMASK
  Netmask for the Mgmt IP Addresses
 --gateway GATEWAY
  Default Gateway for the Mgmt IP Addresses
 --node-mgmt-ips NODE_MGMT_IPS [NODE_MGMT_IPS ...]
  Space separated list of IPs to use for each Node Mgmt LIF
 --node-hosts NODES_HOST [NODES_HOST ...]
  Space separated list of Host IDs to use for this cluster.
  The order of this list matches that of node-names.


(ONTAPdeploy) help cluster create-using-json
usage: cluster create-using-json
--json-file JSON_FILE
[--path PATH]

Create a new cluster
This will deploy an ONTAP Select cluster on the hosts provided. This command can take an extended period of time depending on the size of the storage pool to be consumed for ONTAP Select.
This version of the command accepts a JSON file to provide the complete set of parameters required to create the cluster.  This file needs to be sftp'd to the ONTAP Deploy VM prior to running this command.

Optional arguments:
 --path PATH
  Path to cluster create JSON file location (Env: Home)

Required arguments:
 --json-file JSON_FILE
  Name of the file containing cluster create JSON configuration.


(ONTAPdeploy) help cluster delete
usage: cluster delete
--cluster-name CLUSTER_NAME
[--force]

Delete a given Cluster.
ONTAP Deploy will remove all instances of ONTAP Select deployed on the corresponding hosts included all backing virtual disks. The record of the cluster will then be removed from the ONTAP Deploy VM.
The cluster must be taken offline using the cluster offline command before the cluster can be deleted.

Optional arguments:
 --force
  Delete a cluster without checking for error conditions.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the Cluster


(ONTAPdeploy) help cluster offline
usage: cluster offline
--cluster-name CLUSTER_NAME
[--force]

Take the cluster offline.
ONTAP Deploy will gracefully power down all nodes.

Optional arguments:
 --force
  Request cluster offline with force flag

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the Cluster


(ONTAPdeploy) help cluster online
usage: cluster online
--cluster-name CLUSTER_NAME

Bring the cluster online.
ONTAP Deploy will power on all nodes that are part of this cluster.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the Cluster


(ONTAPdeploy) help cluster show
usage: cluster show
--cluster-name CLUSTER_NAME

Detailed information about the specified cluster.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the Cluster


(ONTAPdeploy) help cluster show-all
usage: cluster show-all

Summary list of all clusters managed by this instance of ONTAP Deploy


(ONTAPdeploy) help configuration backup
usage: configuration backup
[--path PATH]

Backup the ONTAP Deploy VM.
This includes a backup of all configuration information needed to recreate this ONTAP Deploy VM, including all Hosts and Clusters that are currently being managed.

Optional arguments:
 --path PATH
  Directory to store the configuration (Env: Home)


(ONTAPdeploy) help configuration restore
usage: configuration restore
--file-name FILE_NAME
[--path PATH]

Restore an ONTAP Deploy configuration backup.
This command is used to restore a previously backed up ONTAP Deploy configuration. This can be performed on the same VM or a new replacement VM.

Optional arguments:
 --path PATH
  Path to configuration restore file location (Env: Home)

Required arguments:
 --file-name FILE_NAME
  Name of the configuration file


(ONTAPdeploy) help deploy network info
usage: deploy network info

Return network configuration info of deployed VM


(ONTAPdeploy) help event show-all
usage: event show-all
[--level {info,error,warning,debug}
[--category {general,cluster,node,host,license,image,asup,configuration,event,upgrade}]
[--instance INSTANCE]
[--order {normal,reverse}]
[--limit INTEGER]
[--offset INTEGER]

Get events that have occurred in ONTAP Select Deploy.
Events show-all by default shows the last 100 events that have occurred starting with the most recent first.
The limit/offset arguments allow for walking through the events table.
For example -
events show-all --offset 0 --limit 10 --order reverse
- will show the first ten events starting from the oldest first -
events show-all --offset 10 --limit 10 --order reverse
- will show the next ten events -
events show-all --limit 10 --order normal
- will show the 10 most recent events.

Optional arguments:
 --level {info,error,warning,debug}
  Get events filtered by level
 --category {general,cluster,node,host,license,image,asup,configuration,event,upgrade}
  Get events filtered by category
 --instance INSTANCE
  Filter events by instance name.
  Required to be used in conjunction with --category.
 --order {normal,reverse}
  Sort order normal or reverse.
  Normal is newest first, Reverse is oldest first.
 --limit INTEGER
  Maximum number of events to display
 --offset INTEGER
  Starting event offset to display


(ONTAPdeploy) help file delete
usage: file delete
--file FILE
[--path PATH]

Delete the specified file if the user has access.

Optional arguments:
 --path PATH
  File location directory. (Env: Home)

Required arguments:
 --file FILE
  Name of the file to delete


(ONTAPdeploy) help file list
usage: file list
[--path PATH]

List all files in a specified directory if the user has access.

Optional arguments:
 --path PATH
  Path to the directory to list all files. env('HOME')


(ONTAPdeploy) help host add
usage: host add
--host-id HOST_ID
--username USERNAME
[--password PASSWORD]
[--vcenter VCENTER]

Add a host to ONTAP Select Deploy.

Optional arguments:
 --password PASSWORD
  Password for the provided Username
 --vcenter VCENTER
  IP address or FQDN of a vCenter if vCenter credentials are specified (ESX only)

Required arguments:
 --host-id HOST_ID
  IP address or FQDN of the Host to add to ONTAP Select Deploy
 --username USERNAME
  Username with access to this Host


(ONTAPdeploy) help host configure
usage: host configure
--host-id HOST_ID
--location LOCATION
--storage-pool STORAGE_POOL
[--capacity-limit CAPACITY_LIMIT]
[--enable-storage-efficiency]
(--serial-number SERIAL_NUMBER | --eval)
[--internal-network INTERNAL_NETWORK]
[--internal-vlan 0-4094]
--management-network MANAGEMENT_NETWORK
[--management-vlan 0-4094]
--data-network DATA_NETWORK
[--data-vlan 0-4094]
[--instance-type {small,medium}]

Update the configuration of a host.
In order to deploy an ONTAP Select cluster several configuration parameters are required to be set for a given host. This command provides a means to set these parameters

Optional arguments:
 --capacity-limit CAPACITY_LIMIT
  Optional capacity limit for this storage pool in GB.
  ONTAP Deploy will only consume up to this limit when deploying a node on this Host.
  This limit must be less than or equal to the size of the storage pool.
  If this parameter is not specified ONTAP Deploy will consume
  the entire storage pool when deploying a node on this Host.
 --enable-storage-efficiency
  Enable storage efficiency for inline dedupe and compression.
  This parameter is only valid if the storage pool specified with
  '--storage-pool' is local SSD storage
 --internal-network INTERNAL_NETWORK
  Name of the ONTAP Internal Network.
  This is not required for Single Node clusters.
  ESX: Port group
  KVM: Open vSwitch bridge
 --internal-vlan 0-4094
  Optional Vlan ID of the ONTAP Internal Network (Only for KVM)
 --management-vlan 0-4094
  Optional Vlan ID of the ONTAP Management Network (Only for KVM)
 --data-vlan 0-4094
  Optional Vlan ID of the ONTAP Data Network (Only for KVM)
 --instance-type {small,medium}
  Optional name of the instance type to be used for the VM to be deployed on this Host.
  Instance type "small" is (4vCPUs/16GB Memory).
  Instance type "medium" is (8vCPUs/64GB Memory).

Required arguments:
 --host-id HOST_ID
  IP address or FQDN of the host to configure
 --location LOCATION
  A description of the location of this host.
 --storage-pool STORAGE_POOL
  The storage pool to use for when deploying an ONTAP Select node on this host.
 --serial-number SERIAL_NUMBER
  Serial number to be used for the ONTAP Select node on this host.
  This is not required for eval deployments.
 --eval
  Evaluation version of the instance
 --management-network MANAGEMENT_NETWORK
  Name of the ONTAP Management Network.
  The Data and Management networks can be the same or different.
  ESX: Port group.
  KVM: Open vSwitch bridge
 --data-network DATA_NETWORK
  Name of the ONTAP Data Network.
  The Data and Management networks can be the same or different.
  ESX: Port group.
  KVM: Open vSwitch bridge


(ONTAPdeploy) help host remove
usage: host remove
--host-id HOST_ID

Delete a Host from ONTAP Select Deploy
This removes the host from the ONTAP Select Deploy database. A host can only be deleted if the Host is not in use by an ONTAP Select cluster.

Required arguments:
 --host-id HOST_ID
  IP address or FQDN of the Host to delete from ONTAP Select Deploy


(ONTAPdeploy) help host show
usage: host show
--host-id HOST_ID
[--configuration | --detail]

Display detailed information for a Host
This displays hardware and software configuration information regarding this host. The Host must already be added to ONTAP Select Deploy and have already been successfully authenticated.

Optional arguments:
 --configuration
  Display the ONTAP Select Deploy configuration for this host
 --detail
  Display the hypervisor level hardware and software configuration for this host.

Required arguments:
 --host-id HOST_ID
  IP address or FQDN of the host to display


(ONTAPdeploy) help host show-all
usage: host show-all

Return all Hosts added to this instance of ONTAP Select Deploy.


(ONTAPdeploy) help license add
usage: license add
--file-name FILE_NAME
[--path PATH]
[--username USERNAME]
[--password PASSWORD]

Add a new ONTAP Capacity License File.
This command will add the ONTAP Capacity License File to ONTAP Deploy. The license will then be applied to the appropriate ONTAP node that is managed by this instance of ONTAP Deploy.

Optional arguments:
 --path PATH
  Path to the location of the license file. env('HOME')
 --username USERNAME
  ONTAP administrative user
 --password PASSWORD
  Password for the ONTAP administrative user

Required arguments:
 --file-name FILE_NAME
  License file name to add


(ONTAPdeploy) help license delete
usage: license delete
--serial-number SERIAL_NUMBER

Delete a specific license from ONTAP Select Deploy.
A license can only be removed it is not in use on any Host in ONTAP Deploy. An existing license needs to be removed from all hosts before it can be  deleted.

Required arguments:
 --serial-number SERIAL_NUMBER
  Serial number associated with the license


(ONTAPdeploy) help license show
usage: license show
--serial-number SERIAL_NUMBER

Get information on a specific license.

Required arguments:
 --serial-number SERIAL_NUMBER
  Serial number associated with the license


(ONTAPdeploy) help license show-all
usage: license show-all

Get information on all licenses loaded into ONTAP Deploy.


(ONTAPdeploy) help mediator show
usage: mediator show
[--mediator-ip MEDIATOR_IP]

Summary information about a specific mediator.

Optional arguments:
 --mediator-ip MEDIATOR_IP
  IP address of machine where Mediator is installed.
  Defaults to 'localhost'.


(ONTAPdeploy) help mediator show-all
usage: mediator show-all

List of all mediators in use on this ONTAP Deploy


(ONTAPdeploy) help mediator-iscsi-target show
usage: mediator-iscsi-target show
--iqn-name IQN_NAME
[--mediator-ip MEDIATOR_IP]

Information about a specific mediator iSCSI target.

Optional arguments:
 --mediator-ip MEDIATOR_IP
  IP address of machine where Mediator is installed.
  Defaults to 'localhost'.

Required arguments:
 --iqn-name IQN_NAME
  IQN name of the iSCSI target.


(ONTAPdeploy) help mediator-iscsi-target show-all
usage: mediator-iscsi-target show-all
[--stale-targets | --degraded-targets | --active-targets]

List of all mediator iSCSI targets in use on this ONTAP Deploy

Optional arguments:
 --stale-targets
  List iSCSI targets not in use by any ONTAP Select Cluster.
 --degraded-targets
  List iSCSI targets with missing iSCSI connections from ONTAP Select nodes.
 --active-targets
  List iSCSI targets which are in active use by ONTAP Select Clusters.


(ONTAPdeploy) help network connectivity-check cancel
usage: network connectivity-check cancel
--run-id RUN_ID

Cancel a connectivity check run

Required arguments:
 --run-id RUN_ID
  Id of the run to cancel


(ONTAPdeploy) help network connectivity-check delete
usage: network connectivity-check delete
--run-id RUN_ID

Cancel a connectivity check run

Required arguments:
 --run-id RUN_ID
  Id of the run to cancel


(ONTAPdeploy) help network connectivity-check show
usage: network connectivity-check show
--run-id RUN_ID
[--detail]

Display information about a single run of connectivity check.

Optional arguments:
 --detail
  Show detailed output of each subtest

Required arguments:
 --run-id RUN_ID
  Id of the run for which information is to be displayed


(ONTAPdeploy) help network connectivity-check show-all
usage: network connectivity-check show-all

Return last 10 connectivity checks performed from this of ONTAP Deploy.


(ONTAPdeploy) help network connectivity-check start
usage: network connectivity-check start
--host-ids host_id1,host_id2,host_id3,host_id4
--vswitch-type {StandardVSwitch,DistributedVSwitch,OpenVSwitch}
[--mode {quick,extended,cleanup}]
[--mtu MTU]
[--subnet SUBNET]
[--sleep-time SLEEP_TIME]

Initiate a connectivity check network setup between hosts.

Optional arguments:
 --mode {quick,extended,cleanup}
  Run mode for connectivity check.
  Allowed values are quick, extended, cleanup.
  Default: quick
 --mtu MTU
  MTU size to be used for connectivity check run
 --subnet SUBNET
  Subnet to be used to create virtual ports for testing
 --sleep-time SLEEP_TIME
  Time in seconds to sleep before resuming connectivity
  check run after the NICs are brought up. Applies to
  extended mode only

Required arguments:
 --host-ids host_id1,host_id2,host_id3,host_id4
  Comma separated Host Ids(IP address or FQDN) of the
  four hosts to run the test. The hosts must be
  authenticated and configured in ONTAP Deploy.
 --vswitch-type {StandardVSwitch,DistributedVSwitch,OpenVSwitch}
  vSwitch type to be used for connectivity check run.
  Allowed values are:
  StandardVSwitch, DistributedVSwitch, OpenVSwitch.
  ESX: StandardVSwitch or DistributedVSwitch.
  KVM: OpenVSwitch


(ONTAPdeploy) help node console connect
usage: node console connect
--cluster-name CLUSTER_NAME
--node-name NODE_NAME

Connect to the console port of the node.
This provides access to the serial console of the ONTAP Select node.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the cluster
 --node-name NODE_NAME
  Name of the Node to connect to


(ONTAPdeploy) help node console disconnect
usage: node console disconnect
--cluster-name CLUSTER_NAME
--node-name NODE_NAME

Disconnect from the console port of the node.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the cluster
 --node-name NODE_NAME
  Name of the Node to disconnect from


(ONTAPdeploy) help node coredump
usage: node coredump
--cluster-name CLUSTER_NAME
--node-name NODE_NAME
--username USERNAME
[--password PASSWORD]

Trigger this Node to generate a coredump.
This command is to be used by NetApp support only.

Optional arguments:
 --password PASSWORD
  Corresponding password associated with the user

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the Cluster
 --node-name NODE_NAME
  Name of the Node
 --username USERNAME
  Valid user associated with the host


(ONTAPdeploy) help node replace
usage: node replace
--cluster-name CLUSTER_NAME
--node-name NODE_NAME
[--host-id HOST_NAME]
--username USERNAME
[--password PASSWORD]
[--ontap-image-version {9.2,9.1P2}]

The node replace command is used to redeploy a failed node (ONTAP Select VM) in an HA cluster.
Usage of this command is to be done under the supervision of NetApp Support.

Optional arguments:
 --host-id HOST_NAME
  IP address or FQDN of a configured host to create
  replacement node on. This parameter can be skipped if
  the host-id is the same as the host on which the node
  to be replaced was originally deployed
 --password PASSWORD
  ONTAP Select administrative password
 --ontap-image-version {9.2,9.1P2}
  ONTAP Select version to use when recreating the
  node.This parameter can be skipped if the node's ONTAP
  version hasn't changed since its creation.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the cluster where the node to be replaced was deployed
 --node-name NODE_NAME
  Name of the node which is to be replaced
 --username USERNAME
  ONTAP Select administrative user


(ONTAPdeploy) help node savecore
usage: node savecore
--cluster-name CLUSTER_NAME
--node-name NODE_NAME
[--case-number CASE_NUMBER]
[--message MESSAGE]

Save a coredump from the specified node.
This command is to be used by NetApp support only.

Optional arguments:
 --case-number CASE_NUMBER
  Case-number for this core
 --message MESSAGE
  User message for sending the ASUP

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the Cluster
 --node-name NODE_NAME
  Name of the Node


(ONTAPdeploy) help node show-all
usage: node show-all
--cluster-name CLUSTER_NAME

Information on all nodes that are a part of the specified cluster.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the cluster


(ONTAPdeploy) help node start
usage: node start
--cluster-name CLUSTER_NAME
--node-name NODE_NAME

Start the Node. This will power on the VM.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the Cluster
 --node-name NODE_NAME
  Name of the Node


(ONTAPdeploy) help node stop
usage: node stop
--cluster-name CLUSTER_NAME
--node-name NODE_NAME
[--force]

Shutdown the node.

Optional arguments:
 --force
  Forcefully stop the node.
  Normally the node will perform a graceful shutdown.
  With this flag set it will be a forced power off.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the Cluster
 --node-name NODE_NAME
  Name of the Node


(ONTAPdeploy) help storage add
usage: storage add
--cluster-name CLUSTER_NAME
--node-name NODE_NAME
--local-pool LOCAL_POOL
[--mirror-pool MIRROR_POOL]
[--capacity CAPACITY]
--user-name USERNAME
--password PASSWORD

Storage Add feature enables addition of storage to a node in Cluster.

Optional arguments:
 --mirror-pool MIRROR_POOL
  Optional mirror node's storage pool.
  If this node is part of an HA pair,
  the storage pool for the mirror node is required.
 --capacity CAPACITY
  Capacity to add to the node (GB).
  For an HA pair, the capacity is consumed in both the local-pool
  and the mirror-pool. If a capacity is not specified, the
  entire pool space will be consumed.

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the cluster
 --node-name NODE_NAME
  Name of the node
 --local-pool LOCAL_POOL
  Local storage pool to use to add disks to this node in the cluster.
 --user-name USERNAME
  ONTAP administrative user.
 --password PASSWORD
  Password for the ONTAP administrative user.


(ONTAPdeploy) help storage show-host
usage: storage show-host
--host-id HOST_ID

Displays information about storage pools on the host

Required arguments:
 --host-id HOST_ID
  Name of the host


(ONTAPdeploy) help storage show-node
usage: storage show-node
--cluster-name CLUSTER_NAME
--node-name NODE_NAME

Displays information about the vdisks of a Node

Required arguments:
 --cluster-name CLUSTER_NAME
  Name of the cluster.
 --node-name NODE_NAME
  Name of the node.


(ONTAPdeploy) help system config modify
usage: system config modify
[--proxy-url PROXY_URL]
[--product-company PRODUCT_COMPANY]
[--product-site PRODUCT_SITE]

Update the configuration if any new values are provided

Optional arguments:
 --proxy-url PROXY_URL
  URL of a proxy server which provides Internet access.
  ('https://user:password@ip:port')
 --product-company PRODUCT_COMPANY
  Descriptive string that represents the company or
  organization that runs this instance of ONTAP Select Deploy.
 --product-site PRODUCT_SITE
  Description of the location of this ONTAP Select Deploy instance.


(ONTAPdeploy) help system config show
usage: system config show

Get the Global System Configuration


(ONTAPdeploy) help upgrade
usage: upgrade
[--ignore-degraded-clusters] package_path

Upgrade ONTAP Select Deploy

Positional arguments:
 package_path

Optional arguments:
 --ignore-degraded-clusters
  Force upgrade Deploy.
  **Note: This operation could be potentially disruptive
  to two-node clusters which are actively communicating
  with this Deploy instance.


(ONTAPdeploy) help user password modify
usage: user password modify

Modify the unix password and web password for the current user.


(ONTAPdeploy) help version
usage: version

Get ONTAPdeploy Version Information

1 comment:

  1. swiss replica watches, combining elegant style and cutting-edge technology, a variety of styles of replica Audemars Piguet watches, the pointer walks between your exclusive taste style.

    ReplyDelete