Hosts
The S1 system allows the mapping of logical volumes, from the same application instance, to a host or a cluster. The mapping becomes part of a storage area network (SAN) providing a block-level storage.
When to use the hosts command
The hosts
command create a host (or an internal host) designed to
map block-level raw storage resources from logical volumes through iSCSI,
Fiber-channel or NVVMe. To map a provisioned raw data from logical volume, you
need to have a host.
Display available hosts
To display a list of available hosts, use the hosts list
command
Usage:
hosts list [<name>] [--wwn --iqn --nqn] [--mapping] [--ip]
Options:
Options and arguments | Description |
---|---|
<name> |
To limit the results to the name of the specified host (only one host is allowed). |
--wwn |
To display the world wide name identifier (WWN) |
--iqn |
To display the iSCSI Qualified Name (IQN) . |
--nqn |
To display the Network Qualified Name (NQN). |
--mapping |
To display logical volumes that are mapped to hosts. |
--ip |
To display the IP address of the hosts. |
Examples:
-
To list all the hosts, run
hosts list
-
To list all the hosts and to display the IP address of each host, run
hosts list --ip
-
To list all the hosts and to display both the IP address and the iSCSI qualified name for each of the hosts, run
hosts list --ip --iqn
-
To display the IP address, world wide name identifier, the iSCSI qualified name, and the mappings for a host name
hs1
, run hostslist hs1 --ip --wwn --iqn --mapping
-
To list all the hosts and to display IP address, iSCSI qualified name, world wide name identifier, network qualified name, network qualified name, and mapping, run
hosts list --ip --wwn --iqn --nqn --mapping
Creating a host
To create a new host, use the hosts create
command.
Usage:
hosts create <name> [--ip=<name>] (--wwns=<wwn…>| --iqn=<iqn> | --nqn=<nqn>)
Options:
Options and arguments | Description |
---|---|
<name> |
To name the newly created host, replace <name> with a name of your choice. |
--ip=<name> |
To specify an IP Address or DNS name for the newly created host. |
--wwns=<wwn…> |
To specify world wide names. The <wwn…> are used to uniquely identify the hosts on the Fibre Channel network. This allows the storage devices to know which hosts are connected to the network and to establish communication with the appropriate hosts. |
--iqn=<iqn> |
To specify iSCSI qualified name. The <qin> is used to uniquely identify the host on iSCSI network. |
--nqn=<nqn> |
To specify the network qualified name (NVMe). The <nqn> is used to uniquely identify the host on the NVMe-oF network. |
Examples:
-
To create host
hst1
with IP address192.168.60.26
and with iSCSI qualified identifier130
, runhosts create hst1 --ip 192.168.60.26 --iqn iqn.130
-
To create host
NQhs
with IP address192.168.68.212
and with network qualified name2023.org.nv
, runhosts create NQhs --ip 192.168.68.212 --nqn nqn.2023.org.nv
-
To create host
WN
with IP address192.168.75.212
and with world wide name addresses50:06:04:81:D6:F3:45:42
,10:00:00:00:C9:22:FC:01
, and5A:CD:E4:82:34:56:78:98
, runhosts create WN --ip 192.168.75.212 --wwn 50:06:04:81:D6:F3:45:42 10:00:00:00:C9:22:FC:01 5A:CD:E4:82:34:56:78:98
Editing a host
To edit a host, use the hosts edit
command.
Usage:
hosts edit <name> [--newname=<name>] [--ip=<name>] [--wwns=<wwn…>| --iqn=<iqn> | --nqn=<nqn>]
Options:
Options and arguments | Description |
---|---|
<name> |
To specify the name of the host that you want to edit. |
--newname=<name> |
To rename the host. Replace <name> with a name of your choice. |
--ip=<name> |
To edit the IP Address or DNS name of the host. Replace name with an IP address of DNS name. |
--wwns=<wwn…> |
To edit the world wide name addresses. |
--iqn=<iqn> |
To edit the iSCSI qualified name address. |
--nqn=<nqn> |
To edit the network qualified name (NVMe) address. |
Notice: The edit command cannot mix between FC, iSCSI, and NVMeOF protocols. For example, if a host was created with an IQN network protocol, it cannot be modified by the edit command to work with an NQN network protocol.
Examples:
-
To rename host
hs1
tomyHS1
, runhosts edit hs1 --newname myHS1
-
To edit IQN protocol host
hst3
with the following parameters- Change the IP to DNS name:
myiqn.com
. - Change the IQN identifier to
ABCD
. run:
hosts edit hs13 --ip myiqn.com --iqn iqn.ABCD
- Change the IP to DNS name:
-
To edit WWN protocol host
srt
with the flowing parameters- Rename to
kQN
- Change IP address to DNS name
key2storage.com
- Change the unique identifier addresses to world wide name addresses
50:AA:04:81:D6:F3:45:42
50:AA:cc:81:D6:F3:45:42
,
run
hosts edit srt --newname kQN --ip key2storage.com --wwn 50:AA:04:81:D6:F3:45:42 50:AA:cc:81:D6:F3:45:42
- Rename to
Add mapping to a logical volume (host mapping add)
To add mapping between a logical volume and an iSCSi/FC/NVMeOF host, use the hosts mappings add
command
Usage:
hosts mappings add --application=<name> --hosts=<name…> [(--volumes=<name…> --lunIds=<lun_id…>)]
Options:
Options and arguments | Description |
---|---|
--application=<name> |
To specify the application instance associated with the logical volumes that you want to map. |
--hosts=<name…> |
To specify the name of the hosts that will be mapped to the logical volumes. |
--volumes=<name…> |
To specify the name of the logical volumes that will be mapped. if not specified, all volumes within the application instance domain will be mapped. |
--lunIds=<lun_id…> |
To specify the LUN ID, for each host, a mapping between the host and the logical volume should have a unique LUN ID. Replace <lun_id…> with a sequence of integers (separated by space) ranging between 1 to 255. Alternatively, use the next available LUN ID by replacing <lun_id…> with * . |
Notice:
- The LUN ID is an integer ranging between 1-255.
- The LUN ID is for identifying the mapping between a host and a logical volume. Logical volume that are not mapped does not have a LUN ID.
- When you add a mapping between host
A
and logical volumeV
, you are required to enter a LUN ID for this mapping. You can enter any integer between 1 to 255 provided that it has not been used by hostA
to map other logical volumes. - The LUN ID is managed by the host side. If
A
andB
are two different hosts, then it is perfectly legal for them to use the same LUN ID integer to map logical volumes. - You cannot map file/object logical volume.
Examples:
-
To map hosts
hst1
to logical volumeyn2
with LUN ID 1 on application instancesales
, runhosts mappings add --application sales --volumes yn2 --lunIds 1 --hosts hst1
-
To map hosts
hst2
to logical volumexy3
using the next available LUN ID on application instanceHR
, runhosts mappings add --application HR --volume xy3 --lunIds * --hosts hst2
-
To map hosts
h1
to logical volumelv1
andh2
to logical volumeslv2
, where bothlv1
andlv2
are on application instancesales
, runhosts mappings add --application sales --volume lv1 lv2 --lunIds * * --hosts h1 h2
Removing a mapping from a logical volume
To remove a mapping from a logical volume, use the hosts mapping delete
command.
Usage:
hosts mappings delete --application=<name> [--volumes=<name…>] --hosts=<name…>
Options:
Options and arguments | Description |
---|---|
--application=<name> |
To specify the name of the application instance of the logical volumes that are to be unmapped. |
--volumes=<name...> |
To specify the volumes that will be unmaped from the hosts. The name of the volumes you will remove the connectivity to. If not specified, all volumes within the range of the application instance will be unmapped |
--hosts=<name...> |
To specify the name of the hosts that the logical volumes will be unmapped from. |
Examples:
-
To delete (unmap) mapping between host
hst1
and logical volumelv1
on application namesales
, runhosts mappings delete --application sales --volumes lv1 --host hst1
-
Multiple mappings between hosts and logical volumes that are on the same application instance can be deleted. Consider the following mappings:
- Mapping between host
H1
andvol1
on application instanceHR
. - Mapping between host
H2
andvol2
on application instanceHR
. To delete the above mappings, run
hosts mappings delete --application HR --volumes vol1 vol2 --hosts H1 H2
- Mapping between host
Adding WWN to a host
Adding WWN (World Wide Name) to a host refers to the process of associating a unique identifier with a host in a storage area network (SAN) or Fibre Channel environment. Adding WWN to a host configures its Fibre Channel HBA or NIC with a unique identifier. This allows the host to communicate and connect with other devices in the Fibre Channel network. It enables the host to access shared storage resources, transfer data, and participate in SAN activities.
To add WWN to a host, use the host wwn add
command.
Usage:
hosts wwn add <name> --wwns=<wwn…>
Options:
Options and arguments | Description |
---|---|
<name> |
To specify the name of the host that the WWNs will be added to. |
--wwns=<wwn…> |
To specify the fiber channel (FC) world wide names (WWN) that will be added to the host. Replace <wwn…> with a sequence of WWN separated with spaces. |
Examples:
-
To add WWN
50:D6:A4:81:D6:F3:45:42
to a hosths1
, runhosts wwn add hs1 50:D6:A4:81:D6:F3:45:42
-
To add WWNs
50:B6:A4:81:D6:F3:45:42
and50:06:A4:81:D6:F3:55:55
to a hosths1
, runhosts wwn add hs1 50:B6:A4:81:D6:F3:45:42 50:06:A4:81:D6:F3:55:55
Removing WWN from a host
To remove (delete) a WWN from a host, use the command hosts wwn delete
.
Usage:
hosts wwn delete <name> --wwns=<wwn...>
Options:
Options and arguments | Description |
---|---|
<name> |
To specify the name of the host that the WWN will be removed from. |
--wwns=<wwn…> |
To specify the fiber channel (FC) world wide names (WWN) that will be deleted from host. Replace <wwn…> with a sequence of WWN separated with spaces. |
Examples:
Delete a host
To delete a host, use the hosts delete
command.
Examples:
-
To remove WWN
50:D6:A4:81:D6:F3:45:42
from a hosths1
, runhosts wwn add hs1 50:D6:A4:81:D6:F3:45:42
-
To delete WWNs
50:B6:A4:81:D6:F3:45:42
and50:06:A4:81:D6:F3:55:55
from a hosths1
, runhosts wwn add hs1 50:B6:A4:81:D6:F3:45:42 50:06:A4:81:D6:F3:55:55
Usage:
hosts delete <name>
Options:
Options and arguments | Description |
---|---|
<name> |
To specify the name of the host that you want to delete. |
Examples:
-
To delete host name
hst1
, runhosts delete hst1