ION Accelerator™ 2.4.1 Command-Line Interface (CLI) Reference 7.16.
Copyright Notice The information contained in this document is subject to change without notice. Fusion-io MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
CONTENTS About the Command-Line Interface (CLI) ............................................................................................... 11 Command Groups ................................................................................................................. 11 CLI LOGIN .................................................................................................................................... 12 BASIC CLI SYNTAX ......................................................................
BUS COMMANDS ........................................................................................................................ 27 buses or bus:list ..................................................................................................................... 27 bus:get .................................................................................................................................. 28 CHASSIS COMMANDS .............................................................................
INIGROUP COMMANDS ............................................................................................................... 52 inigroup:create ...................................................................................................................... 52 inigroup:delete ...................................................................................................................... 53 inigroup:get ..........................................................................................
POOL COMMANDS ...................................................................................................................... 73 pool:create ............................................................................................................................ 73 pool:delete ............................................................................................................................ 74 pool:get .......................................................................................
saft:url ................................................................................................................................... 94 SERVICE COMMAND .................................................................................................................... 95 service:services ....................................................................................................................... 95 SHELL COMMANDS .............................................................................
target:delete ........................................................................................................................ 113 target:get ............................................................................................................................ 113 targets or target:list ............................................................................................................. 114 target:update...................................................................................
shell:if .................................................................................................................................. 135 shell:join .............................................................................................................................. 136 shell:load ............................................................................................................................. 137 shell:ls ............................................................................
ATTACHING TO A REMOTE ION ACCELERATOR APPLIANCE ...................................................... 155 Appendix C: About the ION Accelerator Guides ...................................................................................
About the Command-Line Interface (CLI) ________________________________________________________________________ With the Command-Line Interface (CLI) you can perform basic configuration tasks, as well as finetune and manage your ION Accelerator system. For an introduction to ION Accelerator, as well as First Boot instructions and a variety of best practices and configuration information, refer to the ION Accelerator Configuration Guide.
Included in many of these command groups are a several basic types of commands: • Create – creates a specific object • Delete – deletes a specific object • Get – gets information about a specific object • List – provides a list of objects of a certain type • Update – changes or sets the information for an object CLI LOGIN To begin using the Command-Line Interface, log in to ION Accelerator at the command line, using the management URL, “Admin” username, and password you chose during installation (
BASIC CLI SYNTAX The basic syntax for the CLI commands is: commandgroup:command --option1 - --option2
- ... arg1 arg2 ... Some options require specified items – these are explained in the next section. The Help and History commands use the syntax of *:help and *:history, respectively. They are explained in detail in the next section. For Fibre Channel, the UUIDs in commands represent WWPNs.
• config –db (lists all the current settings for storage information) • node:update (available in the Setup process) • pool:create (when creating more than one storage pool) • pool: delete (pools can be deleted only in the CLI, not the GUI) • pool:update • raid:create (creating multiple RAIDs) • raid:delete, raid:get, raids, raid:update • soft:dropbox, soft:history, soft:revert, soft:version • volume:create (if the storage profile is Direct Access/JBOD) COMMON OPTIONS The options that are
--display-list Display as a list. For members that are also lists, contents are displayed as arrays. For example: admin@url> nodes -dl id fiona statusEnum MEMBER cluster null ipaddr [192.168.1.1, 192.168.2.1] number id 1 fionb statusEnum MEMBER cluster --display-xml null ipaddr [192.168.1.2, 192.168.2.2] number 2 Display as XML. (Performance statistics are printed as bytes, not in GB.) For example: admin@url> nodes -dx 16885952 192.168.1.
--display-flavor Flavor of display/formatting. Current values are vmware and detailed (for RAID tables). --output-file Save the command output to a file. --output-scp Save the command output via SCP to a user’s home directory on a host. --output-share Save the command output to a CIFS share. --output-usb Save the command output to an attached USB drive.
Command Validation When command validation is enabled, a variety of preconditions are tested on the commands you execute. Any failure of a precondition prints a descriptive message to the console, and the command is not executed.
Piping Output You can also pipe the text output of one command into another, using the piping symbol (“|”). For example, config:config | more will page through the configuration one screen at a time. A convenient pipe command is grep, which allows searching for values. For example: luns -dt | grep some_volume Filtering Output The CLI enables a number of useful forms of filtering.
admin@url> getall = {each (volumes) {volume:get $1}} admin@url> getall vol1 vol2 ... Subcommands are surrounded by parentheses. They are particularly useful with the each command: each (volumes) {volume:get $1} Logging Off, Shutting Down, or Restarting the Server To log off the console, use the exit or quit command. Using exit allows a script to specify a numeric exit code, while quit always returns 0. To restart the server, use the system:restart command.
Quick-Start Tasks ________________________________________________________________________ This section outlines a variety of basic but important tasks you can perform with the CLI. For details on command usage, refer to the Command-Line Reference that follows. Other common but less-critical tasks are outlined in Appendix B: Common CLI Tasks. MANAGEMENT TASKS By running several CLI commands, you can create a basic storage configuration for your ION Accelerator appliance.
5. Create LUNs (export volumes) to share logical storage with initiators. For example: lun:create myVolume newgroup 21:00:00:24:ff:67:5f:60 21:00:00:24:ff:67:5f:61 This creates a LUN by exporting myVolume to the initiator group newgroup using the specified target port WWPNs. 6.
• Assign initiators to the BLUE2 group. • Create a LUN for the BLUE2 initiators to access the Test2 volume.
6. Run soft:history –dt or soft:history –dt --cluster to verify that the node is updated with the latest ION Accelerator software. 7. If you are using HA mode, repeat this procedure on the second node. 8. When you are finished with the update(s), log out of the CLI. The system will automatically reboot. 9. Log back in to the CLI to use the updated software, To revert to a previous version of the software, run soft:version, then soft:revert, then soft:version.
Command-Line Reference ________________________________________________________________________ HELP, HISTORY, VERSION help Displays help for a command. To display a list of all commands in the CLI, press Tab at the command prompt, or type help # and press Enter. Syntax help command Or --help or -h. Examples of the command usage, if available, are displayed with the help.
Arguments Name of the command to get help for command Using Auto-Completion Pressing Tab after beginning to type a CLI command displays the possibilities for completing the command, listed alphabetically. Commands (partial or complete) and options can be autocompleted. Below are a few examples.
You can also substitute into a previous command by using “^” and the parts you want to substitute. This can be useful for correcting errors in long command strings. For example: > drive:get fioa ... info A > ^fioa^fiob^ ... info B After viewing history, you can recall a command to run by typing ! followed by the number of the command you want to run.
Example Below is sample information obtained by running the version --all command: Version Build Number Hotfix Id Update Applied Release Date Description Update State Estimated Update Time Reboot Required Reason 2.4.0 119 "" "Tue Jun 3 20:06:07 MST 2014" "ION Accelerator" COMPLETE 0 false BUS COMMANDS The Bus commands get information about available buses. buses or bus:list Lists the IDs of the available buses. Syntax buses [options] Options –-uuid or -u Show UUIDs instead of readable IDs.
--cluster Issue this command to all instances in the cluster. --sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with Sort the output, extracting key with this function. Example: {$1 method} --where or -w Filter by a function, if the function is true. --where-not or -wn Filter by a function, if the function is false. --used Show only objects that are in use.
(See help –-all for details on all other options.) Arguments The ID, UUID, or WWPN of the bus to get information for id Example This gets details about the bus with the ID pci0000:35 (from bus:list): > bus:get Id UUID Bus Type NUMA Nodes pci0000:35 pci0000:35 pci0000:35 pci [1] CHASSIS COMMANDS The Chassis commands get information about available chassis. chassis or chassis:list Lists the available chassis. Syntax chassis [options] Options –-uuid or -u Show UUIDs instead of readable IDs.
--cluster Issue this command to all instances in the cluster. --sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with Sort the output, extracting key with this function. Example: {$1 method} --where or -w Filter by a function, if the function is true. --where-not or -wn Filter by a function, if the function is false. --used Show only objects that are in use.
Arguments id The ID, UUID, or WWPN of the chassis to get information for Example This gets details about the specified chassis (from chassis:list): > chassis:get bda5e8f9-a3f6-5daf-bf25-ceeeeef562a6 System Serial 2M232406FW System UUID 36353332-3030-324D-3233-323430364657 ID bda5e8f9-a3f6-5daf-bf25-ceeeeef562a6 UUID bda5e8f9-a3f6-5daf-bf25-ceeeeef562a6 BIOS Version P70 BIOS Release Date 12/20/2013 Chassis Type Rack Mount Chassis SKU Manufacturer Errors Warnings CLUSTER COMMANDS The Cluster commands retur
--objects or -o Return objects. –-separator or -s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. --cluster Issue this command to all instances in the cluster. --sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with Sort the output, extracting key with this function.
--cluster Issue this command to all instances in the cluster. (See help –-all for details on all other options.) Arguments id The ID, UUID, or WWPN of the cluster to get information for Example This gets details about the cluster with the ID ionr8i47 (from cluster:list): > cluster:get mycluster Id ionr8i47 IP 10.60.34.47 Errors Warnings UUID ionr8i47 CNA COMMANDS The CNA commands return information about Converged Networking Adapters.
–-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all instances in the cluster. --sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with Sort the output, extracting key with this function.
cna:get Gets information about a CNA, including fabric type, interconnect, slot #, product name, and vendor. Syntax cna:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster See –-urlList above. (See help –-all for details on all other options.
CONFIG COMMANDS The Config commands provide the ability to backup and restore the configuration of an ION appliance, and to apply that configuration when provisioning other appliances. config:alter Alters an existing configuration. Syntax config:alter [options] configuration Options --no-auto or -na Do not automatically repair the configuration problems.
--input-ssh or -ih Use Unix shell file input, such as user[:password]@host:filename --input-url or -ir Load a configuration from a URL. For example, http://somehost/filename or ftp://[username[:password]@]host/path/file --input-usb or -iu Load a configuration from the USB drive. --current-file Read the current configuration from a file, instead of from ION Accelerator. --current-url Read the current configuration from a URL, instead of from ION Accelerator.
--share Windows (CIFS) share to load configuration from --domain Domain for Windows (CIFS) share user --user or -u User name --password or –p Password for the user --output-file or -of Save command output to a file or directory --output-scp or -os Save command output to an SCP destination (user[:pass]@host[:dest]) --output-share or -oc Save command output to a CIFS share (domain/user[:pass]@host/share[/dest]) --output-usb or -ou Save comma
config:config Retrieves all or part of a configuration, depending on the options. If you provide the --include option, the set of elements to include starts empty. If you provide the --exclude option, the set starts with everything. Syntax config:config [options] Options --flatten Flatten the resulting configuration into a simple list of objects. --include or -i Include only this type of result, starting with the empty set.
TARGET: [tgt, tgt] CNA: [QLogic Corporation-QLE2562-LFD1014B42206] PORT: [21:00:00:24:ff:21:23:4c, 21:00:00:24:ff:21:23:4d] INITIATOR_GROUP: [ini] INITIATOR: [21:00:00:1b:32:8b:49:77, 21:01:00:1b:32:ab:49:77, 50:01:43:80:04:25:ce:6c] SOFTWARE: SoftwareVersion [version=2.0.
--input-scp or -is Use SCP input. For example, user[:password]@host:filename --input-share or -iu Use CIFS/Windows input. For example, domain/user[:password]@host/share/filename --input-ssh or -ih Use Unix shell file input, such as user[:password]@host:filename --input-url or -ir Use URL input. For example, http://somehost/filename or ftp://[username[:password]@]host/path/file --input-usb or -iu Use content retrieved from the USB drive.
This restores the configuration from an http URL. • restore --input-share adomain/auser@myhost/ashare/cfg.xml This restores a configuration from a Windows (CIFS) share. config:verify Returns TRUE if the configuration can be applied to the current node. Syntax config:verify [options] configuration Options --input-last Load the last known configuration. --input-file or -if Use file input. --input-url or -ir Use URL input.
Arguments configuration Configuration object to modify, or variable containing the configuration config:wipe Wipes (deletes) the specified resources. Syntax config:wipe [options] Option (required) --wipe or -w Types of resources to wipe (delete all of). Types include: lun, volume, pool, raid, target, initiator, inigroup, all (See help –-all for details on all other options.) CPU COMMANDS The CPU commands get information about CPUs in the ION Accelerator host.
–-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all instances in the cluster. --sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with Sort the output, extracting key with this function. Example: {$1 method} --where or -w Filter by a function, if the function is true.
--cluster Issue this command to all instances in the cluster. (See help –-all for details on all other options.) Arguments id The ID or UUID of the CPU to get information for Example This gets information about CPU 11 (from cpu:list): > cpu:get 11 Id 11 UUID 11 Core Id 5 Vendor GenuineIntel Family 6 Model 45 Uarch sandybridge-e Mhz 2493.812 Thread Siblings 11,23 NUMA Node 1 DRIVE COMMANDS The Drive commands manipulate physical disk structures in the ION Accelerator host.
--objects Return objects. –-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all instances in the cluster. --sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output.
drive:get [options] id Options –-boot or -b Specify that the drive is a boot device. –-rescan or -r Force rescan of boot devices. –-node or -n Issue this command to one or more nodes in the cluster. Issue this command to all instances in the cluster. --cluster (See help –-all for details on all other options.
Options –-uuid or -u Show UUIDs instead of readable IDs. –-node or -n Issue this command to one or more nodes in the cluster. –-property or -p --objects or -o Properties to display: • id – ID of the cluster • uuid – Machine-readable ID • ipaddr – Cluster IP address Return objects. –-separator or -s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab.
fan:get Gets details about a fan. Syntax fan:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. Issue this command to all instances in the cluster. --cluster (See help –-all for details on all other options.) Arguments The ID, UUID, or WWPN of the fan to get information for id Example This gets details about the fan with the ID fan1.
--ppci Print the PCI bus ID of the device node. (See help –-all for details on all other options.) Arguments device-node ioDrive device control node, such as /dev/fct1 Example This turns on the beacon for the fct1 device and prints its PCI bus ID: > fio:beacon –-on --ppci /dev/fct1 PCI address: f:0.0 /dev/fct1 beacon ON fio:status Determines the status of Fusion-io devices by displaying a variety of information fields.
Arguments device Pathname to the control device Example This displays the status for the /dev/fct1 device: > fio:status /dev/fct1 Found 1 ioMemory device in this system with 1 ioDrive Duo as device '/dev/fct1' Driver version: 3.2.6 build 1219 Adapter: Dual Controller Adapter Fusion-io ioDrive2 Duo 2.41TB, Product Number:F01-001-2T41-CS0001, SN:1150D0032, FIO SN:1150D0032 External Power: NOT connected PCIe Power limit threshold: 55.
FORMAT COMMAND The format command formats objects. format:format Formats objects. Syntax format [options] item(s) Options --flatten or -f Flattens a collection of arguments into a single one --maxdepth or –m Maximum depth for flattening arguments; default is 4 Arguments item Objects to flatten. This argument can be used multiple times. INIGROUP COMMANDS The Inigroup commands enable you to manipulate named groups of initiators.
–-type or -t Optional type of the initiator group: default or aix. The blocksize for creating AIX groups must be 512B. –-if_not_exists or -ne If an object with the given identifier already exists, skip creation. (See help –-all for details on all other options.) Arguments id Human-readable id for the initiator group initiator Optional identifier of initiator to add to this group. This option can be included multiple times.
inigroup:get Gets details about an initiator group, including type and parent (if any), the IDs for the initiators in the group, and the group UUID. Syntax inigroup:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
–-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or --n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. --sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with Sort the output, extracting key with this function.
Options –-parent_uuid or –p New parent group UUID --rename or –-id or -i Rename this initiator group to the specified string. (See help –-all for details on all other options.) Arguments id The ID or UUID of the initiator group to update Example This updates (renames) the oldgroup initiator group to newgroup: > inigroup:update --id newgroup INITIATOR COMMANDS The Initiator commands enable you to create, delete, list, get information for, and update remote SCSI initiators.
WWPN:f8:e9:d2:c3:b4:a5:f6:e7 IQN: iqn.1992-01.com.exampl:dsk.sys1.xy[3] GID: 0002:c903:004c:7535 id Human-readable identifier for the initiator Example This creates the initiator init22 at WWPN 21:00:00:24:ff:67:5f:60 … > initiator:create --assign init22 21:00:00:24:ff:67:5f:60 initiator:delete Deletes an initiator. Syntax initiator:delete [options] id(s) Options –-node or --n Issue this command to one or more nodes in the cluster.
initiator:get Gets information about an initiator, including UUID, protocol, discovery status, and initiator group ID. Syntax initiator:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. Arguments id The ID, UUID, or WWPN to get information for Example This gets information about the win_1 initiator (from initiator:list): > initiator:get win_1 id win_1 UUID iqn.1991-05.com.
–-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. --sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with Sort the output, extracting key with this function.
Options –-rename or -id or –i Rename the initiator to the specified string. --assign or –a Assign the initiator to a group. (See help –-all for details on all other options.) Arguments initiator ID or UUID of the initiator to update Example This assigns the initiator to a group named init22. > initiator:update --assign init22 KDUMP COMMANDS The kdump commands get information about kernel dumps. To clear kdump messages, use the system:messages –clear command.
Options –-verbose or –v Show additional information while processing. (See help –-all for details on all other options.) Arguments dumpName Name of the kdump to get information for Example This gets details about the kdump named kdump1: > kdump:get kdump1 kdump:delete Deletes a kdump. Syntax kdump:delete [options] dumpName Options (See help –-all for details on all other options.) Arguments dumpName Name of the kdump to delete.
Syntax log:servicereport [options] show Options --include or -I Part(s) of the service report to include: clusters, cnas, config, crm_resource_list, fio_agent_log, fio_msrv_log, fio_saft_log, fio_scst_conf, fio_status, inigroups, initiators, ion_default, ion_out, ionservice, lib_fio, luns, lvdisplay, lvs, messages, nodes, pools, ports, processes, pvdisplay, pvs, raids, scst_groups, scst_sessions, scst_tmp, suse_studio_custom, targets, updatectrl_log, vgdisplay, vgs, volumes --exclude or -X
Creates a standard service report and place it on the USB drive (if available) • servicereport --output-share domain/user@host/share Sends the report to a CIFS share • servicereport --output-scp user@host Sends the report through scp to user's home directory on the host LUN COMMANDS The LUN commands enable you to create, delete, list, get information for, and update LUNs.
–-all-targets or -a Create the LUN with all available targets. (See help –-all for details on all other options.) Arguments volume Volume to export as a LUN initiatorGroup Name of the initiator group to assign the LUN to target Target for the created LUNs. This argument may be used multiple times.
(See help –-all for details on all other options.) Arguments id ID, UUID, or WWPN of the LUN to delete. This argument may be used multiple times. Example This deletes testLUN: > lun:delete testLUN lun:get Gets details about a LUN. Syntax lun:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
Options –-volume or –v List LUNS on the current volume. –-target or –t List LUNS on a specified target. –-uuid or –u Show UUIDs instead of readable IDs.
--cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.) Example This lists all the available LUNs: > luns cfff0cee-fd89-11e3-8e78-009c023ca2a8-LUN0 cfff0cee-fd89-11e3-8e78-009c023ca2a8-LUN1 cfff0cee-fd89-11e3-8e78-009c023ca2a8-LUN10 cfff0cee-fd89-11e3-8e78-009c023ca2a8-LUN11 cfff0cee-fd89-11e3-8e78-009c023ca2a8-LUN12 ... Viewing LUNs by Volume You can extract a subset of LUNs for one or more volumes by using the commands below. 1.
------------------------------------------------------------------21:00:00:24:ff:66:a1:e8 |21:00:00:24:ff:66:a1:e8 |FC |false |ea65a7f2-aa4a-11e2-bb4f-90b11c06e928 MANAGE COMMAND The Manage command enables Oracle Enterprise Manager (OEM) integration. manage:oem Controls integration with the Oracle Enterprise Manager product through a custom plug-in.
NETWORK COMMANDS The Network commands enable you to see details for network addresses, including Ethernet ports, IP addresses, and subnets. network:addrs Shows network address details for components of the ION Accelerator system. Syntax network:addrs [options] Options (See help –-all for details on all options.) Example This shows network address details for Ethernet ports: > network:addrs eth3 inet 192.168.20.49/24 eth0 inet 10.60.34.49/24 eth5 inet 192.168.30.49/24 eth6 inet 192.168.1.
Example This shows network address details: > network:ping 192.168.20.49 PING 192.168.20.49 (192.168.20.49) 56(84) bytes of data. 64 bytes from 192.168.20.49: icmp_seq=1 ttl=64 time=0.031 ms 64 bytes from 192.168.20.49: icmp_seq=2 ttl=64 time=0.010 ms 64 bytes from 192.168.20.49: icmp_seq=3 ttl=64 time=0.017 ms --- 192.168.20.49 ping statistics --3 packets transmitted, 3 received, 0% packet loss, time 1998ms rtt min/avg/max/mdev = 0.010/0.019/0.031/0.
Status Errors Warnings Local Slots IP Node# Chassis Monitor URL Gateway DNS NTP TZ State USB Status Uptime Member false 192.168.1.1 192.168.2.1 1 Normal UsbNotlocal(5) nodes or node:list Lists available nodes. Syntax nodes [options] Options –-uuid or –u Show UUIDs instead of readable IDs.
--objects or –o • gateway – IP address of the gateway • timezone – Time zone (three characters) of the node Return objects. –-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or --n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. --sort Sort the output, using the specified Property name to sort on.
node:local Returns the ID or UUID of the local node in a cluster. In a cluster management scenario, it may not be obvious which node you are connected to, so this command returns the information for you. Syntax node:local [options] Options –-uuid or –u Show the UUID instead of the readable ID. (See help –-all for details on these options: --display, --output-file) Example This shows the UUID of the local node in the cluster.
--cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.) Arguments id Identifier for the new pool device Device to include in the pool. This argument may be used multiple times. Example This creates a new storage pool called mainpool, from the device IDs specified, with a physical extent size (pesize) of 512KB: > pool:create --pesize 512 mainpool fioa fiob fioc fiod fioe fiof fiog fioh pool:delete Deletes a pool.
pool:get Gets information about a pool, including pool capacity, errors and warnings (if any), devices, free/extents, free/usable space, extent size, maximum usable capacity, free usable capacity, profile ID and name, and volume names. Syntax pool:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
pools or pool:list Lists available pools. Syntax pools [options] Options –-uuid or -u Show UUIDs instead of readable IDs. –-property or -p One or more initiator group properties to display --objects or -o Return objects. –-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or -n Issue this command to one or more nodes in the cluster.
Example This lists all available storage pools in the system: > pools max raid10 pool:update Updates a pool. Syntax pool:update id(s) Options --rename or -id or –i Rename the pool with the specified UUID or WWPN. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.) Arguments id Existing ID, UUID, or WWPN of the pool to be updated.
PORT COMMANDS The Port commands enable you to get and set information for the ports on a CNA. port:get Gets information on a port. Syntax port:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
• status – One of the following values: 0 = STATUS_DISCONNECTED – Port is disconnected. 1 = STATUS_CONNECTED – Port is connected. --objects or -o • address – MAC address • MTU – Maximum Transmission Unit for the port • ip_address – IP address Return objects. –-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or -n Issue this command to one or more nodes in the cluster.
Example This displays the names of the available ports, separated by spaces: > ports –s eth0 eth1 eth2 eth3 eth4 eth5 eth6 eth7 port:update Updates a port. Syntax port:update [options] id Options --mode Mode for the port: management or iscsi or cluster Ports cannot be changed to or from cluster mode. --ip-address or -ip IP address to set for the port --subnet-mask or -s Subnet mask to set for the port –-mode Mode of the port.
PROFILE COMMANDS The profile commands enable you to create and examine profile configurations for storage pools. profile:create Creates a storage pool with desired characteristics. You can run profile:create –dt to see the available profile types. A storage profile created in the CLI will not be reflected or available in the GUI. Syntax profile:create [options] profile (name) Options --slot or -s Allow the use of the specified slot; by default all are allowed. Use slot or node/slot.
Examples • profile:create maximum_performance This creates a storage pool that emphasizes maximum performance, across all available devices. • profile:create reliable_performance This creates a storage pool that ensures reliability, across all available devices. • profile:create reliable_capacity This creates a storage pool that ensures reliability but emphasizes capacity over performance. • profile:create -d 2 direct This creates a direct (JBOD) using two of the available devices.
profiles or profile:list Lists available profiles for storage pools. Syntax profiles [options] Options –-uuid or -u Show UUIDs instead of readable IDs. –-property or -p --objects or -o One or more properties to display Return objects. –-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or -n Issue this command to one or more nodes in the cluster.
Example This lists the profiles, separated by spaces:: > profiles –s JBOD RAID0 DAID10 RAID5 PSU COMMANDS The PSU commands get information about available power supply units. psu or psu:list Lists the available power supply units. Syntax psu:list [options] Options –-uuid or -u Show UUIDs instead of readable IDs. –-node or -n Issue this command to one or more nodes in the cluster. –-property or -p --objects or -o Properties to display (can be used multiple times) Return objects.
--where or -w Filter by a function, if the function is true. --where-not or -wn Filter by a function, if the function is false. --used Show only objects that are in use. --not-used or -nu Show only objects that are not in use. (See help –-all for details on all other options.) psu:get Gets details about a power supply unit. Syntax psu:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster.
RAID COMMANDS The RAID commands enable you to create, delete, list, get information about, and update RAID arrays. Multiple block devices are input to create a RAID 0 or a RAID 1. If you need to create a RAID 10 configuration, use the reliable_performance argument with the profile:create command. You can use --display-flavor detailed to show more information about the RAID table. raid:create Creates a RAID array with a unique ID.
Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.) Arguments id The ID, UUID, or WWPN of the RAID to delete. This argument may be used multiple times.
> raid:get md0 Id md0 Type raid1 Capacity 1,204.87 GB Chunk Size RAID Device /dev/md0 Errors Warnings Devices /dev/fiof /dev/fiod Spares [] Faults [] Rebuild 100% State clean Status Sync idle UUID 9e44f89f-4890-3df1-4bf0-e4723f85c54c raids or raid:list Lists the RAID IDs. Syntax raids [options] Options --boot or –b Include only boot devices. --rescan or –r Force rescan of boot devices. –-uuid or -u Show UUIDs instead of readable IDs.
• raidtype – One of the following values: 0 = RAID 0 1 = RAID 1 2 = RAID 10 3 = RAID 5 • status – Current status of the RAID • rebuild_pct – Current progress percentage toward completing the RAID rebuild --objects or -o Return objects. –-separator or –s Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comma, and tab. –-node or --n Issue this command to one or more nodes in the cluster.
Example This lists the RAID IDs, separated by spaces: > raids –s md0 md1 md2 md3 raid:update Updates a RAID device. Syntax raid:update [options] id Options --boot or –b Include only boot devices. --rescan or –r Force rescan of boot devices. --fault or –fail or -f Mark a device as failed/faulted. --add or -a Add one or more devices to the RAID array. --remove or -r Remove one or more devices from the RAID array.
RULES COMMANDS The rules commands manipulate and get information for rule contexts in the CLI. rules:compile Compiles rule contexts. Syntax rules:compile [options] Options --context or -c Name of the rule context (See help –-all for details on all other options.) rules:delete Deletes rule contexts. Syntax rules:delete [options] contextName(s) Options (See help –-all for details on all other options.) Arguments contextName Name of the rule context to delete.
(See help –-all for details on all other options.) rules:insert Inserts objects into working memory. Syntax rules:insert [options] object(s) Options --run or -r Run rules after inserting objects. --context or -c Name of the rule context (See help –-all for details on all other options.) Arguments object Object to insert into working memory. This argument can be used multiple times. rules:reset Resets rules.
--verbose or -v Show more details. --context or -c Name of the rule context (See help –-all for details on all other options.) Example This lists the rules: > raids –s md0 md1 md2 md3 rules:run Runs rules and returns the number of rules that were fired.
SAFT COMMANDS The saft commands list objects in the system and manage SAFT service access. saft:list Lists a selected type of objects. Syntax saft:list [options] type Options –-uuid or -u Show UUIDs instead of readable IDs. --objects or -o Return objects. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
Arguments URL URL (or host or port, depending on the option set) used to connect to SAFT. SERVICE COMMAND The service command gets the state of CLI services. The CLI may start certain services while operating, such as a zeroconf daemon. This command lists the services that are running, or have run at any point, and their current states. service:services Lists CLI service states. Syntax service:services [options] Options (See help –-all for details on all other options.
Options –-node or -n Issue this command to one or more nodes in the cluster. Issue this command to all instances in the cluster. --cluster (See help –-all for details on all other options.) Example This gets SNMP information: > snmp:get Enabled Location Client Address Community Contact Trap Addresses Trap Community true Server Room 127.0.0.1 public Sysadmin (root@localhost) [] snmp:mibs Downloads a .zip file containing the MIBs defined on the target ION Accelerator server.
--contact Contact information --location Location information --trap-address Set the trap destination address. --trap-community Community for traps --enable Enable SNMP. --disable Disable SNMP. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all instances in the cluster. (See help –-all for details on all other options.
soft:apply Applies the software update in the drop-box to the ION Accelerator appliance. The drop-box is a temporary location for the pending software update file. After the upgrade finishes, you must log out of the CLI. Although a console message will state that no restart is necessary, the system will automatically reboot. Syntax soft:apply [options] Options –-no-wait Do not wait for the result of the apply/restart; return immediately after requesting.
• retval – Integer, with one of the following: o 0 = SUCCESS – The update software in the drop-box is valid. o -801 = UPDATE_BAD_SIGNATURE – The update software is invalid; it has a bad signature. o -802 = UPDATE_BAD_METADATA – The update software is invalid; it has bad metadata. o -805 = UPDATE_EMPTY_DROPBOX – No update software was found in the dropbox.
(See help –-all for details on all other options.
soft:update Uploads an update package and then applies it to the ION Accelerator system. Syntax soft:update [options] Options –-no-wait Do not wait for the result of the apply/restart; return immediately after requesting. --quiet or -q Do not print status messages. --file or -f File containing the update package --web or -w Web address (URL) to download the update package from --noparts Force upload of update as one file (for older ION systems).
Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.) Example This uploads the iontest.iop software update file from the specified web address to the dropbox area, so it can be installed with the soft:apply command: > soft:upload --file iontest.iop --web https:exampledownload.fusionio.com soft:version Returns the current software version information.
soft:versions Displays the ION software update history. Syntax soft:versions [options] Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
Arguments host Host to close tunnels to. This argument can be used multiple times. Example This closes all active SSH tunnels. ssh:close --all ssh:exec Executes a command over SSH. Syntax ssh:exec [options] command(s) Options --user or -u User name --password or -p Password --port Port ID (defaults to 22) --host Host to connect to (See help –-all for details on all other options.) Arguments command Command to execute. This argument can be used multiple times.
--host Remote host to connect to (See help –-all for details on all other options.) Arguments localFile Local file to copy destination Remote filename or directory. Most (but not all) systems will accept a path and file name here. If this argument is left blank, the local filename will be used. Examples > scpput config.xml someone@srv This copies config.xml from local directory to the home directory of someone on host srv. > scpput /tmp/config.xml someone@srv:/tmp This copies /tmp/config.
--disconnect Disconnect after executing the command. --user or -u User name for the remote system --password or -p Password for the remote system --port Port to use for the file copy (defaults to 22) --host Host to connect to (See help –-all for details on these options: --display, --output-file) Arguments command Command to execute. This argument can be used multiple times. Any of the following values can be used: CD: Change the remote directory.
PUT_RESUME: Resume copy to remote [remote]. PWD: Print the remote directory. READLINK: Print the target of a link . REALPATH: Print the full path of a file . RENAME: Rename a remote file . RM: Remove a remote file [file]*. RMDIR: Remove a remote directory +. STAT: Retrieve information about a remote file . SYMLINK: Link a remote file . VERSION: Print the remote SSH version.
SYSTEM COMMANDS system:keys Sets up interconnect key pairs.
system:maintenance Sets maintenance mode on or off. Maintenance mode disables all storage access, but management tasks are available. Entering maintenance mode is useful when hardware needs to be replaced in a server, for example. Syntax system:maintenance [options] mode Options --wait or –w Maximum seconds to wait for the system to respond to the update request. Use --wait 0 to return immediately. –-node or -n Issue this command to one or more nodes in the cluster.
system:restart Restarts a designated node. Syntax system:restart [options] Options --wait or –w Maximum seconds to wait for the system to respond to the update request. Use --wait 0 to return immediately. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
database, and restarts the services resetvols – Removes constraints on a failed node so failover can occur Example This enables you to configure the time zone for the server at the console: system:setup timezone See also Quick Start Tasks: Changing Node Names and IP Addresses earlier in this guide. system:shutdown Shuts down a designated node. Syntax system:shutdown Options --wait or –w Maximum seconds to wait for the system to respond to the update request. Use --wait 0 to return immediately.
Example This shows the current configuration and maintenance state for the ION Accelerator system: > system:status TARGET COMMANDS The Target commands represent a protocol-specific endpoint for SCSI communication. Initiators connect to targets via a discovered network address. See also Port Commands. target:create Manually creates a target, specifying a name and optionally specifying a UUID for the target. The UUID field accepts WWPNs (such as f8:e9:d2:c3:b4:a5:f6:e7), IQNs (such as iqn.199201.com.
target:delete Deletes a target. Syntax target:delete [options] id(s) Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.) Arguments id ID, UUID, or WWPN of target to delete. This argument may be used multiple times. Example This deletes the target named testTarget: > target:delete testTarget target:get Gets details about a target.
Example This gets details about the eth3 target (from target:list): > target:get target Id eth3 UUID iqn.2007-02.com.fusionio:sn.2m232406fw:eth3 Protocol iSCSI Enabled true State Online Err/Warn [] Statistics targets or target:list Lists the target IDs. Syntax targets [options] Options –-uuid or -u Show UUIDs instead of readable IDs. –-property or –p --objects or -o One or more properties to display: • id – Target ID • uuid – Target UUID • protocol – FC, IB, or iSCSI Return objects.
Sort the output, extracting key with this function. Example: {$1 method} --where or -w Filter by a function, if the function is true. --where-not or -wn Filter by a function, if the function is false. --used Show only objects that are in use. --not-used or -nu Show only objects that are not in use. (See help –-all for details on all other options.
--issue-lip or -l Issue a LIP to the target. --rename or --id or –i Set a new ID. --remove-id or -r Remove the ID assigned to a target, reverting to its natural identifier. --all or -a Issue the command against all targets. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
TEMP (TEMPERATURE) COMMANDS The Temp commands get information about temperature sensors. temp:get Gets information on a temperature sensor. Syntax temp:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.) Arguments id Human-readable target identifier temps or temps:list Lists available temperature sensors.
--sort Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with Sort the output, extracting key with this function. Example: {$1 method} --where or -w Filter by a function, if the function is true. --where-not or -wn Filter by a function, if the function is false. --used Show only objects that are in use. --not-used or -nu Show only objects that are not in use.
--exclude or –e Exclude one or more of the following element types from the graph: boot_drives, boot_raids, bus, chassis, cluster, cna, cpu, drive, fan, inigroup, initiator, lun, node, numa, pool, port, profile, psu, raid, snmp, software, target, temp, volume --from Specify the start of a range of elements. See the above list for the --exclude option. --to Specify the end of a range of elements. See the above list for the -exclude option.
You can also capture the current configuration into a variable, and reuse it: admin@url> admin@url> admin@url> admin@url> cfg = graph graph graph (config --cluster --parallel) --format dot $cfg --output configuration.svg $cfg --format pdf --output configuration.pdf $cfg VOLUME COMMANDS The Volume commands model storage to be presented as a LUN of a target. A volume of specified capacity is allocated from a pool.
Options --repair Repair, after servicing. --minor Supply a code for the minor version, to be used with the –-repair option. --if-not-exists or -ne If an object with the given identifier already exists, skip creation. --local or -l Create a volume on this node only, if in a cluster. –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster. (See help –-all for details on all other options.
Options (See help –-all for details on all other options.) Arguments volume ID or UUID of the volume to delete. This option can be used multiple times. Example This deletes the volume named testVol: > volume:delete testVol volume:get Gets a variety of information on a volume. Syntax volume:get [options] id Options –-node or -n Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the cluster.
Bytes Written UUID Nodes 0 mcl0vs-aBLF-xRf0-eNxW-yC1b-Q6UN-kcuYrd ionr8i48 ionr8i49 volumes or volume:list Lists available volumes. Syntax volumes [options] Options –-uuid or -u Show UUIDs instead of readable IDs.
Example: {$1 method} --where or -w Filter by a function, if the function is true. --where-not or -wn Filter by a function, if the function is false. --used Show only objects that are in use. --not-used or -nu Show only objects that are not in use. (See help –-all for details on all other options.
Example This increases the capacity of myVolume to 100GB: > volume:update –capacity_gb 100 myVolume 125
Appendix A: Shell Commands for Scripting ________________________________________________________________________ The Shell command group contains core commands similar to the functions commonly found in Unix shells. Commands in this group include piping and routing output, formatting output, control structures (looping and closures), and miscellaneous functions. These shell commands can be useful for running scripts to manage or configure ION Accelerator systems.
shell:cat Displays the content of a file or URL. Syntax shell:cat [options] paths or URLs Options --n Number the output lines, starting at 1. Arguments paths or URLs List of file paths or URLs to display, separated by whitespace (use for STDIN) Example This displays the contents of both file1 and file2, with numbered lines for each: shell:cat file1 file2 shell:cd Changes the current environment path. Syntax shell:cd [options] path Options (See help –-all for details on all other options.
shell:compare Uses an operator to compare two arguments. Syntax shell:compare [options] left operator right Options --not Negate the logic of the operator.
shell:display Sets the default display/formatting. Syntax shell:display [options] displayType (flavor) Options (See help –-all for details on all other options.) Arguments displayType Formatting or display type (see Common Options for details) flavor Flavor of the display type, if available shell:each Executes a closure on a list of arguments. See also Filtering Output in Other Functionality earlier in this guide.
--order-with Sort the output, extracting the key with this function. Example: {$1 method} --unique Remove duplicates from the results. --where or -w Filter by a function. --where-not or -wn Keep where this function is false. (See help –-all for details on all other options.) Arguments values Collection of arguments to iterate on function Function to execute Examples > each (seq 5) { echo $1 } This loops over the numbers 1 through 5, printing each of them.
--logLevel Log level to use (implies --log). Valid values include: trace, debug, info, warning, error --logCategory Log category to use (implies --log). (See help –-all for details on all other options.) Arguments argument One or more arguments to display, separated by spaces shell:eval Evaluates a binary operation, or executes a command provided as a string. This command can also be used to do mathematics, or to construct a string as a command and then evaluate it.
shell:explain Analyzes the last error and attempts to provide additional information. Syntax shell:explain [options] Options --max or –m Maximum number of rules to fire (defaults to all) --timeout or –s Timeout for rule execution, in seconds (defaults to 30) --context or –c Name of rule context (defaults to “explain”) (See help –-all for details on all other options.) shell:filter Keeps or discards objects that match a pattern, optionally extracting a field.
Options --name or -name Name to search for (such as “file.txt” or “*.txt”). This option is repeatable. --regex or -regex Regex pattern to match against names. This option can be specified multiple times. --maxdepth or -maxdepth Maximum depth to search --mindepth or -mindepth Minimum depth to search (matches must be at least at this depth) --not or -not Find items that do not match. --dir or -dir Match only directories (environments).
--arg Additional arguments to pass to the function (numbered $3 and higher) (See help –-all for details on all other options.) Arguments values Collection of arguments to iterate on input First input value function Closure, where $1 is the value and $2 is the input shell:grep Prints lines matching the given pattern. Syntax shell:grep [options] pattern Options --line-number or -n Prefix each line of output with the line number within its input file.
-context or -C Print NUM lines of output context. This places a line containing ’--’ between contiguous groups of matches. --only-matching or –o Print only the part of the line that matches the expression. --group or –g Print the contents of the regex group. Group 0 is the entire pattern. --group-separator or –sep When printing multiple groups, use this item to separate them. (See help –-all for details on all other options.
Details This CLI command checks a condition: if true, it executes the ifTrue function; if false, it executes the optional ifFalse function. The condition can be a value or a function itself. If it's a function, it will be called to get the condition value. Boolean values will be used directly. Numeric values are true if not equal to 0. String values are true if non-empty; null is false.
--delimiter or -d Place a delimiter between the arguments. This implies the --string option. (See help –-all for details on all other options.) Arguments arguments Items to join into a string shell:load Loads the CLI environment tree from a file. Syntax shell:load [options] treeFile Options --input-file or -if Use file input. --input-url or -ir Use URL input.
Arguments treeFile Tree file to load. This defaults to the standard CLI tree location in your profile. shell:ls Lists the contents of the current directory, or a provided path. Syntax shell:ls [options] path Options --long or -l Use the long form. --all or -a List hidden entries as well. (See help –-all for details on all other options.) Arguments path Tree path to list shell:man Shows detailed information for one or more CLI commands at the console.
Syntax shell:markdown [options] Options (See help –-all for details on all other options.) shell:mkdir Creates a new environment path in the CLI tree. Syntax shell:mkdir [options] path Options --if-not-exists or -i Create the path if it doesn’t already exist. --parents or -p Create parent directories as needed. (See help –-all for details on all other options.) Arguments path Path to create shell:more View the contents of a text file one screen at a time.
Arguments from Name of item to move to New name or location shell:printf Returns a formatted string, based on arguments. Syntax shell:printf [options] format arguments Options --echo or -e Echo the formatted string to the output stream, appending a newline if it doesn’t end with one. (See help –-all for details on all other options.
Options (See help –-all for details on all other options.) shell:rm Removes a variable from the CLI environment. Syntax shell:rm [options] path Options (See help –-all for details on all other options.) Arguments path Path to the variable to remove shell:rmdir Removes a CLI environment path. Syntax shell:rmdir [options] path Options (See help –-all for details on all other options.) Arguments path Desired environment path (root, if not provided) shell:save Saves the environment tree.
shell:seq Generates a sequence of numbers, or pattern-formatted strings. For a detailed discussion of format strings usable with the --format option, see http://docs.oracle.
Options (See help –-all for details on these options: --display, --output-file) Arguments setting Any of the following values: ACTOR_SYSTEM_NAME: Name of the actor system, when used ANSI: Show color text. AUTOCOMPLETE_LIMIT: Time, in seconds, to wait for the auto- completer to retrieve information CACHE_SAFT: Cache CLI instances. COMPATIBILITY: Handle backwards compatibility. CONFIRMATION: For some commands, prompt the user before execution takes place.
PROMPT_SHOW_USER: Show the current user name in the prompt. READ_TIMEOUT_SECONDS: Time, in seconds, to wait for a response from a CLI host REST_LOG_PROMPT: When logging REST, log transactions related to the prompt. REST_LOG: REST call logging REST_LOG_URLS_ONLY: When logging REST, record only the URLs, not the responses. ROOT_SAFT_URL_OVERRIDE: Provide a CLI URL to be used instead of the one contained in the root of the environment tree.
USERNAME: A user name VALIDATE: If false, prevent checking of command parameters prior to execution. WATCH_AUTO: Build out necessary watches automatically during execution. value Value to set shell:sleep Causes the CLI to sleep for a short time and then wake up. Syntax shell:sleep [options] duration Options --second or –s Use a duration time of seconds instead of milliseconds. Arguments duration Amount of time to sleep.
--numeric-sort or –n Compare according to string numerical value Arguments files List of files separated by spaces shell:source Runs a script. Syntax shell:source script arg(s) Options --input-file or -if Use file input. --input-url or -ir Use URL input. For example, http://somehost/filename or ftp://[username[:password]@]host/path/file --input-usb or -iu Use content retrieved from the USB drive. --input-share or -ic Use CIFS/Windows input.
Examples shell:source --input-file hello.fik Load the hello.fik file, executing the script it contains. shell:source --input-scp user:pass@host:setup.fik Run setup.fik from an scp source, then execute it. shell:source --input-share domain/user@host/share_name/setup.fik Run setup.fik from CIFS/Windows share named share_name. shell:source --input-url http://somehost/setup.fik Run setup.fik from the given URL. shell:tac Concatenates input to a string and returns the result.
Arguments path or URL File path or URL to display shell:tee Sends stdin to stdout and other specified locations. Syntax shell:tee [options] Options --file or -f Send content to a file. --binary or -b Use no text decoding/encoding; just do a binary copy.
Arguments test Type of test: exists, used, in_cluster, or connection type Object type: bus, chassis, cluster, cna, cpu, drive, fan, inigroup, initiator, lun, node, pool, port, psu, raid, target, temp, volume terms Terms to use shell:throw Throws a Java exception. This is useful for simulating error conditions. Syntax shell:throw [options] className message Options (See help –-all for details on all other options.
Appendix B: Common CLI Tasks ________________________________________________________________________ This appendix describes some common tasks that may be useful in working with the ION Accelerator CLI. Other common tasks are outlined in the About the Command-Line Interface (CLI) section. For complete details on command syntax, as well as usage examples for most commands, see the Command-Line Reference section.
Back up to a Windows/CIFS share with a generated filename. Back up to a Windows/CIFS share, using a specific filename. Back up to a Windows/CIFS share, providing a password. Back up to a specific file. Back up to the USB drive. backup --output-share domain/user@host/shareName backup --output-share domain/user@host/shareName/filename.xml You will be prompted for a password. backup --output-share domain/user:password@host/shareName A generated filename will be used. backup --output-file my_config.
Routing Input Some commands require files as input. Here are some examples: Task Restore from a config file in the user's home directory Restore from a USB drive Example restore my_config.xml restore --input-usb my_config.xml Restore from an scp source restore --input-scp user@host:my_config.xml Restore from a Windows share restore --input-share domain/user@host/shareName/my_config.xml Restore from an http URL restore --input-url http://host:port/my_config.
WORKING WITH THE CLI ENVIRONMENT (TREE) The CLI can store settings, aliases, and other configuration into its preferences file. By default this file is stored in ~/.fikon/tree.xml. You interact with the tree in a way that is similar to working with a file system. Fikon's tree is a nested set of environments (directories). Each environment has variables in it, and each environment can contain child environments. Task List the contents of the current environment. Example ls Make a child environment.
Load your Fikon envionment from an scp source load --input-scp user@host:my_env.xml Loads the Fikon environment from an scp source, prompting you for the password to use. Working with Tree Settings Settings show up in your current tree location and are visible as uppercase entries. When you create a setting, it is inherited by all child environments below your current environment. Task Remove a setting. Remember settings. Change the fio-saft timeout. Show interactions with fio-saft.
ATTACHING TO A REMOTE ION ACCELERATOR APPLIANCE You can run the CLI on a workstation or laptop and then attach it to a remote ION Accelerator system. This is done with an SSH tunnel. Task Example 1. Make an environment. 2. Set up a tunnel. 3. Set up authentication 4. Test the connection drives 5. Save the connection save mkdir remote cd remote url=ssh:// user= password= Description Creates an environment in the Fikon tree, and changes into that environment.
Appendix C: About the ION Accelerator Guides _____________________________________________________________________ The ION Accelerator CLI Reference helps you use the ION Accelerator software in a command-line environment, including setting up a storage profile and pools, creating volumes, adding initiators, managing ioMemory, etc.
