Host commands – INFINIDAT Support

The following host commands allow you to create a host, to map a volume or a snapshot to a host and to query the mapping, to add a port to a host and to query the ports by host.

host.add_port

ROLE: Admin, Pool Admin

Description	Add port to host.
Syntax	`host.add_port host=HOST port=[(WWN\|IQN0,(WWN\|IQN)...] [type=FC\|ISCSI]`
Arguments	`type`	iSCSI or FC
	`port`	Logged in initiator (multiple values, separated by commas)
	`host`	Name of an existing host
Example	`host.add_port name=host1 port=1000000c9c06f340`
	`FFC port 1000000c9c06f340 added to host host1`

host.clear_chap

ROLE: Admin, Pool Admin

Example
Description	Clears CHAP settings. This command clears the CHAP username and secret from both initiator and target This command clears the CHAP authentication type and sets the host CHAP to NONE
Syntax	`host.clear_chap host=HOST`
Arguments	`host`	Name of an existing host
	`host.clear_chap host=h1`
	`Host "h1" CHAP settings cleared`

host.create

ROLE: Admin, Pool Admin

Description	Create a new host.
Syntax	`host.create name=NAME [host_type={DEFAULT\|ESXI\|HPUX}]`
Arguments	`host_type`	DEFAULT, ESXI or HPUX
	`port`	A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.
Example	`host.create name=host1`
	`Host host1 created`

host.delete

ROLE: Admin, Pool Admin

Example
Description	Delete host.
Syntax	`host.delete host=HOST`
Arguments	`host`	Name of an existing host
	`host.delete name=host1`
	`Host host1 deleted`

host.initiator_query

ROLE: Admin, Pool Admin

Description	List logged-in initiators which are not assigned to any host in the system. Run the command with no parameter to return both FC and ISCSI initiators Run the command using the protocol parameter in order to filter out the query results.
Syntax	`host.initiator_query [{ISCSI\|FC}]`
Arguments	`protocol`	iSCSI or FC
Example	Query for FC initiators
	`host.initiator_query protocol=FC`
	`WWPN PROTOCOL 21000024ff3cee01 FC 21000024ff3cf0cc FC`
Example	Query for ISCSI initiators
	`host.initiator_query protocol=ISCSI`
	`WWPN PROTOCOL iqn.1994-05.com.infinidat:iscsi-man03 iSCSI iqn.1994-05.com.infinidat:iscsi-man02 iSCSI iqn.1994-05.com.infinidat:iscsi-man04 iSCSI iqn.1994-05.com.infinidat:iscsi-man01 iSCSI`

host.map

ROLE: Admin, Pool Admin

Description	Map a volume or a snapshot to a host.
Syntax	`host.map host=HOST [vol=VOL[,VOL,...]] [snap=SNAP[,SNAP,...]] [lun=LUN]`
Arguments	`lun`	SCSI logical unit number (LUN)
	`snap`	Name of an existing volume snapshot (multiple values, separated by commas)
	`vol`	Name of an existing volume (multiple values, separated by commas)
	`host`	Name of an existing host
Example	`host.map name=host1 vol=vol1`
	`Volume vol1 mapped to LUN LUN1 in host host1`

host.map_query

ROLE: All Roles

Description	List existing mappings for hosts (clustered hosts included).
Syntax	`host.map_query [host=HOST] [map_type={HOST\|CLUSTER}]`
Arguments	`map_type`	CLUSTER or HOST
	`host`	Name of an existing host
Example	`host.map_query`
	HOST VOLUME LUN ID MAPPING TYPE h1 vol1 1 HOST h2 vol2 11 CLUSTER

host.port_query

ROLE: All Roles

Description	List ports of existing hosts. Hosts with no ports are not listed.
Syntax	`host.port_query [host=HOST] [port=SCSIADDRESS]`
Arguments	`port`	A WWN or IQN address. A WWN address consists of a 16-digit hexadecimal number, optionally delimited by colons to 8 groups of two digits each. An IQN address begins with the string "iqn.", optionally followed by a domain registration date, followed by an organizational naming authority, and optionally followed by a colon and a custom string of choosing, e.g "iqn.2001-04.com.example:diskarrays-sn-a8675309".
	`host`	Name of an existing host
Example	An output example for an FC host
	`host.port_query name=host1`
	`HOST TYPE PORT LOGGED IN host1 FC 1000000c9c06f340 yes`
Example	An output example of an iSCSI host
	`host.port_query`
	`HOST TYPE PORT LOGGED IN interop006 ISCSI iqn.1991-05.com.microsoft:interop006 yes interop008 ISCSI iqn.1991-05.com.microsoft:interop008 no`

host.query

ROLE: All Roles

Description	List existing hosts.
Syntax	`host.query [host=HOST[,HOST,...]] [cluster=CLUSTER[,CLUSTER,...]] [auth_type={NONE\|CHAP\|MUTUAL_CHAR},{NONE\|CHAP\|MUTUAL_CHAR}...]] [host_type={DEFAULT\|ESXI\|HPUX}]`
Arguments	`host_type`	DEFAULT, ESXI or HPUX
	`auth_type`	Authentication method required of host when connecting through iSCSI: NONE, CHAP or MUTUAL_CHAP (multiple values, separated by commas)
	`cluster`	Name of an existing cluster (multiple values, separated by commas)
	`host`	Name of an existing host (multiple values, separated by commas)
Example	Running the command for with no parameters
	`host.query`
	`NAME CLUSTER LUNS FC PORTS ISCSI IQNS AUTH TYPE CREATED AT iscsi-man01 - 3 0 1 NONE 2016-05-10 10:00:00 iscsi-man02 - 3 0 1 NONE 2016-05-10 10:00:00`
Example	Running the command in detailed mode
	`host.query name=iscsi-man01 --detailed`
	`Name iscsi-man01 Cluster - LUNs 3Allocated Capacity 32.98 TB FC Ports 0 iSCSI IQNs 1 Auth Type NONE CHAP Target User - CHAP Initiator User - Created At 2016-07-25 10:00:00 Updated AT 2016-07-25 10:00:00`

host.remove_port

ROLE: Admin, Pool Admin

Description	Remove port from host.
Syntax	`host.remove_port host=HOST port=[(WWN\|IQN),(WWN\|IQN)...] [type=(FC\|ISCSI)]`
Arguments	`host`	Name of an existing host
	`type`	iSCSI or FC
	`port`	A WWN or IQN address. A WWN address consists of a 16-digit hexadecimal number, optionally delimited by colons to 8 groups of two digits each. An IQN address begins with the string "iqn.", optionally followed by a domain registration date, followed by an organizational naming authority, and optionally followed by a colon and a custom string of choosing, e.g "iqn.2001-04.com.example:diskarrays-sn-a8675309". (multiple values, separated by commas)
Example	`host.remove_port name=host1 port=1000000c9c06f340`
	`FC port 1000000c9c06f340 removed from host host1`

host.rename

ROLE: Admin, Pool Admin

Description	Rename host.
Syntax	`host.rename host=HOST new_name=NAME`
Arguments	`new_name`	A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.
	`host`	Name of an existing host
Example	`host.rename name=host1 new_name=host2`
	`Host host1 renamed to host2`

host.set_auth_type

ROLE: Admin, Pool Admin

Description	Set iSCSI host authentication method. Inbound secret - the key with which the host authenticates with InfiniBox Outbound secret - the key with which InfiniBox authenticates with the host Available authentication types: CHAP - the host has to authenticate with InfiniBox MUTUAL_CHAP - both host and InfiniBox have to authenticate to each other NONE - no authentication is required
Syntax	`host.set_auth_type host=HOST type=METHOD`
Arguments	`type`	Authentication method required of host when connecting through iSCSI: NONE, CHAP or MUTUAL_CHAP
	`host`	Name of an existing host
Example	Setting the authentication method of an iSCSI host to CHAP
	`host.set_auth_type name=h1 type=chap`
	`Host "h1" iSCSI authentication type set to CHAP, auto-generated inbound secret: 'MVqaQWmB572mB0xzeito'`
Example	Setting the authentication method of an iSCSI host to MUTUAL_CHAP
	`host.set_auth_type name=h1 type=MUTUAL_CHAP`
	`Host "h1" iSCSI authentication type set to MUTUAL_CHAP, auto-generated inbound secret: 'cbAl0V2yk6mhLEyV3PAt', auto-generated outbound secret: 'yYqXkGNzxR8CZIjQpjii'`
Example	Removing an existing authentication requirement
	`host.set_auth_type name=h1 type=NONE`
	`Host "h1" iSCSI authentication type set to NONE`

host.set_chap

ROLE: Admin, Pool Admin

Description	Set iSCSI host CHAP usernames and secrets.
Syntax	`host.set_chap host=HOST [inbound_user=STR] [inbound_secret=STR] [outbound_user=STR] [outbound_secret=STR]`
Arguments	`host`	Name of an existing host
	`outbound_secret`	Any sequence of characters
	`outbound_user`	Any sequence of characters
	`inbound_secret`	Any sequence of characters
	`inbound_user`	Any sequence of characters
Example	Setting the host authentication without details
	`host.set_chap name=h1`
	`Host "h1" CHAP settings updated`
Example	Setting the inbound name and secret
	`host.set_chap name=h1 inbound_user=admin inbound_secret=cbA10V2yk6mhLEyV3PAe`
	`Host "h1" CHAP settings updated`

host.set_host_type

ROLE: Admin, Pool Admin

Description	Set host type.
Syntax	`host.set_host_type host=HOST host_type=[DEFAULT\|ESXI\|HPUX]`
Arguments	`host`	Name of an existing host
	`host_type`	DEFAULT, ESXI or HPUX

host.set_path_optimized_state

ROLE: Admin, Pool Admin

Description	Set ALUA optimized state for LUNS mapped to a host.
Syntax	`host.set_path_optimized_state host=HOST optimized=YESNO`
Arguments	`optimized`	Either yes or no
	`host`	Name of an existing host

host.unmap

ROLE: Admin, Pool Admin

Description	Unmap a volume or a snapshot from a host.
Syntax	`host.unmap host=HOST [vol=VOL[,VOL,...]] [snap=SNAP[,SNAP,...]] [lun=LUN[,LUN,...]]`
Arguments	`snap`	Name of an existing volume snapshot (multiple values, separated by commas)
	vol	Name of an existing volume (multiple values, separated by commas)
	host	Name of an existing host
	`lun`	SCSI logical unit number (LUN) (multiple values, separated by commas)
Example	`host.unmap name=host1 vol=vol1`
	`Volume vol1 unmapped from LUN LUN1 in host host1`

host.add_port

host.clear_chap

host.create

host.delete

host.initiator_query

host.map

host.map_query

host.port_query

host.query

host.remove_port

host.rename

host.set_auth_type

host.set_chap

host.set_host_type

host.set_path_optimized_state

host.unmap

Last edited: 2022-08-06 08:32:28 UTC

Comments

INFINIDAT Support InfiniShell InfiniBox Commands Host commands

host.add_port

host.clear_chap

host.create

host.delete

host.initiator_query

host.map

host.map_query

host.port_query

host.query

host.remove_port

host.rename

host.set_auth_type

host.set_chap

host.set_host_type

host.set_path_optimized_state

host.unmap

Last edited: 2022-08-06 08:32:28 UTC

Comments

INFINIDAT Support

InfiniShell

InfiniBox Commands

Host commands