ION Accelerator™ 2.4.1 Command-Line Interface (CLI) Reference 7.16.2014
ATTACHING TO A REMOTE ION ACCELERATOR APPLIANCE ... 155 Appendix C: About the ION Accelerator Guid
(See help –-all for details on all other options.) Return Values The following values are returned in each history list: • update_date – Date this so
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
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
soft:versions Displays the ION software update history. Syntax soft:versions [options] Options –-node or -n <address(es)> Issue this command
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:
--host <string> Remote host to connect to (See help –-all for details on all other options.) Arguments localFile Local file to copy destina
--disconnect Disconnect after executing the command. --user or -u <string> User name for the remote system --password or -p <string>
PUT_RESUME: Resume copy to remote <local> [remote]. PWD: Print the remote directory. READLINK: Print the target of a link <link>. REALPAT
SYSTEM COMMANDS system:keys Sets up interconnect key pairs. Syntax system:keys [options] verb(s) key Options --force or -f Force the creation or rem
system:maintenance Sets maintenance mode on or off. Maintenance mode disables all storage access, but management tasks are available. Entering mainte
About the Command-Line Interface (CLI) ________________________________________________________________________ With the Command-Line Interface (
system:restart Restarts a designated node. Syntax system:restart [options] Options --wait or –w <integer> Maximum seconds to wait for the syst
database, and restarts the services resetvols – Removes constraints on a failed node so failover can occur Example This enables you to configure the
Example This shows the current configuration and maintenance state for the ION Accelerator system: > system:status TARGET COMMANDS The Target co
target:delete Deletes a target. Syntax target:delete [options] id(s) Options –-node or -n <address(es)> Issue this command to one or more nod
Example This gets details about the eth3 target (from target:list): > target:get target Id eth3 UUID iqn.2007-02.com.fusionio:sn.2m23240
Sort the output, extracting key with this function. Example: {$1 method} --where or -w <function> Filter by a function, if the function
--issue-lip or -l Issue a LIP to the target. --rename or --id or –i <string> Set a new ID. --remove-id or -r Remove the ID assigned to
TEMP (TEMPERATURE) COMMANDS The Temp commands get information about temperature sensors. temp:get Gets information on a temperature sensor. Syntax t
--sort <property> Sort the output, using the specified Property name to sort on. --no-sort or -ns Do not sort the output. --order-with <
--exclude or –e <format> Exclude one or more of the following element types from the graph: boot_drives, boot_raids, bus, chassis, cluster
Included in many of these command groups are a several basic types of commands: • Create – creates a specific object • Delete – deletes a specific
You can also capture the current configuration into a variable, and reuse it: admin@url> cfg = (config --cluster --parallel) admin@url> graph
Options --repair Repair, after servicing. --minor <integer> Supply a code for the minor version, to be used with the –-repair option. --if-
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 ti
Bytes Written 0 UUID mcl0vs-aBLF-xRf0-eNxW-yC1b-Q6UN-kcuYrd Nodes ionr8i48 ionr8i49 volumes or volume:list Lists a
Example: {$1 method} --where or -w <function> Filter by a function, if the function is true. --where-not or -wn <function> Filter
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 conta
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. Argu
shell:compare Uses an operator to compare two arguments. Syntax shell:compare [options] left operator right Options --not Negate the logic of the op
shell:display Sets the default display/formatting. Syntax shell:display [options] displayType (flavor) Options (See help –-all for details on all oth
BASIC CLI SYNTAX The basic syntax for the CLI commands is: commandgroup:command --option1 <item> --option2 <item> ... arg1 arg2 ... Some
--order-with <function> Sort the output, extracting the key with this function. Example: {$1 method} --unique Remove duplicates from the
--logLevel <level> Log level to use (implies --log). Valid values include: trace, debug, info, warning, error --logCategory <string>
shell:explain Analyzes the last error and attempts to provide additional information. Syntax shell:explain [options] Options --max or –m <level&g
Options --name or -name <string> Name to search for (such as “file.txt” or “*.txt”). This option is repeatable. --regex or -regex <stri
--arg <list> Additional arguments to pass to the function (numbered $3 and higher) (See help –-all for details on all other options.) Argument
-context or -C Print NUM lines of output context. This places a line containing ’--’ between contiguous groups of matches. --only-matching or –o P
Details This CLI command checks a condition: if true, it executes the ifTrue function; if false, it executes the optional ifFalse function. The condi
--delimiter or -d <string> Place a delimiter between the arguments. This implies the --string option. (See help –-all for details on all othe
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 di
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
• config –db (lists all the current settings for storage information) • node:update (available in the Setup process) • pool:create (when creating mo
Arguments from Name of item to move to New name or location shell:printf Returns a formatted string, based on arguments. Syntax shell:printf [opt
Options (See help –-all for details on all other options.) shell:rm Removes a variable from the CLI environment. Syntax shell:rm [options] path Optio
shell:seq Generates a sequence of numbers, or pattern-formatted strings. For a detailed discussion of format strings usable with the --format option,
Options (See help –-all for details on these options: --display, --output-file) Arguments setting Any of the following values: ACTOR_SYSTEM_NAME: N
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_P
USERNAME: A user name VALIDATE: If false, prevent checking of command parameters prior to execution. WATCH_AUTO: Build out necessary watches automati
--numeric-sort or –n Compare according to string numerical value Arguments files List of files separated by spaces shell:source Runs a script. Synt
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
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
Arguments test Type of test: exists, used, in_cluster, or connection type Object type: bus, chassis, cluster, cna, cpu, drive, fan, inigroup, ini
--display-list Display as a list. For members that are also lists, contents are displayed as arrays. For example: admin@url> nodes -dl id fio
Appendix B: Common CLI Tasks ________________________________________________________________________ This appendix describes some common tasks
Back up to a Windows/CIFS share with a generated filename. backup --output-share domain/user@host/shareName Saves to a Windows share; you will almost
Routing Input Some commands require files as input. Here are some examples: Task Example Description Restore from a config file in the user's ho
WORKING WITH THE CLI ENVIRONMENT (TREE) The CLI can store settings, aliases, and other configuration into its preferences file. By default this file
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
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.
Appendix C: About the ION Accelerator Guides _____________________________________________________________________ The ION Accelerator CLI Refe
--display-flavor <string> Flavor of display/formatting. Current values are vmware and detailed (for RAID tables). --output-file <filename
Command Validation When command validation is enabled, a variety of preconditions are tested on the commands you execute. Any failure of a preconditi
Piping Output You can also pipe the text output of one command into another, using the piping symbol (“|”). For example, config:config | more will pa
admin@url> getall = {each (volumes) {volume:get $1}} admin@url> getall vol1 vol2 ... Subcommands are surrounded by parentheses. They are partic
Copyright Notice The information contained in this document is subject to change without notice. Fusion-io MAKES NO WARRANTY OF ANY KIND WITH REGAR
Quick-Start Tasks ________________________________________________________________________ This section outlines a variety of basic but importan
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
• Assign initiators to the BLUE2 group. • Create a LUN for the BLUE2 initiators to access the Test2 volume. Here is the script that does the tasks:
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 us
Command-Line Reference ________________________________________________________________________ HELP, HISTORY, VERSION help Displays help for a c
Arguments command Name of the command to get help for Using Auto-Completion Pressing Tab after beginning to type a CLI command displays the possibi
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 c
Example Below is sample information obtained by running the version --all command: Version 2.4.0 Build Number 119
--cluster Issue this command to all instances in the cluster. --sort <property> Sort the output, using the specified Property name to sort
(See help –-all for details on all other options.) Arguments id The ID, UUID, or WWPN of the bus to get information for Example This gets details a
CONTENTS About the Command-Line Interface (CLI) ... 11 C
--cluster Issue this command to all instances in the cluster. --sort <property> Sort the output, using the specified Property name to sort
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):
--objects or -o Return objects. –-separator or -s <type> Separator between property values when printing multiple properties; defaults to
--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 WW
–-separator or –s <type> Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comm
cna:get Gets information about a CNA, including fabric type, interconnect, slot #, product name, and vendor. Syntax cna:get [options] id Options –-no
CONFIG COMMANDS The Config commands provide the ability to backup and restore the configuration of an ION appliance, and to apply that configuration
--input-ssh or -ih <string> Use Unix shell file input, such as user[:password]@host:filename --input-url or -ir <URL> Load a co
--share <string> Windows (CIFS) share to load configuration from --domain <string> Domain for Windows (CIFS) share user --user or -u
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
BUS COMMANDS ... 27 buses or bus
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] IN
--input-scp or -is <string> Use SCP input. For example, user[:password]@host:filename --input-share or -iu <string> Use CIFS/Windows
This restores the configuration from an http URL. • restore --input-share adomain/auser@myhost/ashare/cfg.xml This restores a configuration from a
Arguments configuration Configuration object to modify, or variable containing the configuration config:wipe Wipes (deletes) the specified resourc
–-node or -n <address(es)> Issue this command to one or more nodes in the cluster. --cluster Issue this command to all instances in the cl
--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 t
--objects Return objects. –-separator or –s <type> Separator between property values when printing multiple properties; defaults to tab.
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 &l
Options –-uuid or -u Show UUIDs instead of readable IDs. –-node or -n <address(es)> Issue this command to one or more nodes in the cluster
fan:get Gets details about a fan. Syntax fan:get [options] id Options –-node or -n <address(es)> Issue this command to one or more nodes in t
INIGROUP COMMANDS ... 52 inigroup:create
--ppci Print the PCI bus ID of the device node. (See help –-all for details on all other options.) Arguments device-node ioDrive device cont
Arguments device Pathname to the control device Example This displays the status for the /dev/fct1 device: > fio:status /dev/fct1 Found
FORMAT COMMAND The format command formats objects. format:format Formats objects. Syntax format [options] item(s) Options --flatten or -f Fla
–-type or -t <InitiatorGroupType> Optional type of the initiator group: default or aix. The blocksize for creating AIX groups must be 512B.
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.
–-separator or –s <type> Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comm
Options –-parent_uuid or –p <string> New parent group UUID --rename or –-id or -i <string> Rename this initiator group to the specif
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 initiato
initiator:get Gets information about an initiator, including UUID, protocol, discovery status, and initiator group ID. Syntax initiator:get [options]
–-separator or –s <type> Separator between property values when printing multiple properties; defaults to tab. Valid values are space, comm
POOL COMMANDS ... 73 pool:create .
Options –-rename or -id or –i <string> Rename the initiator to the specified string. --assign or –a <string> Assign the initiator to
Options –-verbose or –v Show additional information while processing. (See help –-all for details on all other options.) Arguments dumpName Name o
Syntax log:servicereport [options] show Options --include or -I <part(s)> Part(s) of the service report to include: clusters, cnas, config,
Creates a standard service report and place it on the USB drive (if available) • servicereport --output-share domain/user@host/share Sends t
–-all-targets or -a Create the LUN with all available targets. (See help –-all for details on all other options.) Arguments volume Volume to expor
(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. Ex
Options –-volume or –v <string> List LUNS on the current volume. –-target or –t <string> List LUNS on a specified target. –-uuid or –u
--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 L
------------------------------------------------------------------- 21:00:00:24:ff:66:a1:e8 |21:00:00:24:ff:66:a1:e8 |FC |false |ea65a7f2-aa4a-11e2-b
NETWORK COMMANDS The Network commands enable you to see details for network addresses, including Ethernet ports, IP addresses, and subnets. network:a
saft:url ... 94 SERVI
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 19
Status Member Errors Warnings Local false Slots IP 192.168.1.1
• gateway – IP address of the gateway • timezone – Time zone (three characters) of the node --objects or –o Return objects. –-separator or –s &l
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 connecte
--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:get Gets information about a pool, including pool capacity, errors and warnings (if any), devices, free/extents, free/usable space, extent size,
pools or pool:list Lists available pools. Syntax pools [options] Options –-uuid or -u Show UUIDs instead of readable IDs. –-property or -p <lis
Example This lists all available storage pools in the system: > pools max raid10 pool:update Updates a pool. Syntax pool:update id(s) Options --r
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 [
• status – One of the following values: 0 = STATUS_DISCONNECTED – Port is disconnected. 1 = STATUS_CONNECTED – Port is connected. • address – MAC
target:delete ... 113 target:get
Example This displays the names of the available ports, separated by spaces: > ports –s eth0 eth1 eth2 eth3 eth4 eth5 eth6 eth7 port:update Update
PROFILE COMMANDS The profile commands enable you to create and examine profile configurations for storage pools. profile:create Creates a storage poo
Examples • profile:create maximum_performance This creates a storage pool that emphasizes maximum performance, across all available devices. • p
profiles or profile:list Lists available profiles for storage pools. Syntax profiles [options] Options –-uuid or -u Show UUIDs instead of readable
Example This lists the profiles, separated by spaces:: > profiles –s JBOD RAID0 DAID10 RAID5 PSU COMMANDS The PSU commands get information abou
--where or -w <function> Filter by a function, if the function is true. --where-not or -wn <function> Filter by a function, if the
RAID COMMANDS The RAID commands enable you to create, delete, list, get information about, and update RAID arrays. Multiple block devices are input t
Options –-node or -n <address(es)> Issue this command to one or more nodes in the cluster. --cluster Issue this command to all nodes in the
> raid:get md0 Id md0 Type raid1 Capacity 1,204.87 GB Chunk Size RAID Device /dev/md0 Errors Warnings Devices
• 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 – Cur
shell:if ... 135 shell
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] i
RULES COMMANDS The rules commands manipulate and get information for rule contexts in the CLI. rules:compile Compiles rule contexts. Syntax rules:com
(See help –-all for details on all other options.) rules:insert Inserts objects into working memory. Syntax rules:insert [options] object(s) Options
--verbose or -v Show more details. --context or -c <string> Name of the rule context (See help –-all for details on all other options.) Ex
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:li
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 CL
Options –-node or -n <address(es)> Issue this command to one or more nodes in the cluster. --cluster Issue this command to all instances in
--contact <string> Contact information --location <string> Location information --trap-address <string> Set the trap destinat
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 softwar
• 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
Commentaires sur ces manuels