Managing compute ports
Obtaining a list of information about compute ports (CLI or REST API)
The following information can be obtained.
-
id: IDs (uuid) of compute ports
-
protocol: Connection protocols of compute ports
-
type: Types of compute ports
-
nickname: Nicknames of compute ports
-
name: WWNs or iSCSI names of compute ports
-
configuredPortSpeed: Link speed setting
-
portSpeed:
(Virtual machine) Always “DependsOnHypervisor”
(Bare metal) Actual link speed
-
portSpeedDuplex:
(Virtual machine) Link speed only (for FC connection configuration) or always "DependsOnHypervisor" (for iSCSI connection configuration)
(Bare metal) Actual link speed and duplex settings of the physical port used for communication
-
protectionDomainId: IDs (uuid) of protection domains containing compute ports
-
storageNodeId: IDs (uuid) of storage nodes containing compute ports
-
interfaceName: Interface name
-
statusSummary: Summary of statuses of compute ports
-
status: Status of each compute port
-
fcInformation:
(Virtual machine) FC port information
(Bare metal) Null
-
iscsiInformation: iSCSI port information
Before you begin
Required role: Security, Storage, Monitor, Service, or Resource
Procedure
Obtain a list of information about compute ports.
REST API: GET /v1/objects/ports
CLI: port_list
Obtaining information about individual compute ports (CLI or REST API)
The following information can be obtained for the compute port with the ID specified.
-
id: ID (uuid) of the intended compute port
-
protocol: Connection protocol of the intended compute port
-
type: Type of the intended compute port
-
nickname: Nickname of the intended compute port
-
name: WWN or iSCSI name of the intended compute port
-
configuredPortSpeed: Link speed setting
-
portSpeed:
(Virtual machine) Always “DependsOnHypervisor”
(Bare metal) Actual link speed
-
portSpeedDuplex:
(Virtual machine) Link speed only (for FC connection configuration) or always "DependsOnHypervisor" (for iSCSI connection configuration)
(Bare metal) Actual link speed and duplex settings of the physical port used for communication
-
protectionDomainId: ID (uuid) of the protection domain containing the intended compute port
-
storageNodeId: ID (uuid) of the storage node containing the intended compute port
-
interfaceName: Interface name
-
statusSummary: Summary of statuses of compute ports
-
status: Status of each compute port
-
fcInformation:
(Virtual machine) FC port information
(Bare metal) Null
-
iscsiInformation: iSCSI port information
Before you begin
Required role: Security, Storage, Monitor, Service, or Resource
Procedure
Verify the ID of the intended compute port.
If you use the CLI to specify a compute port by WWN or iSCSI name, check the WWN or iSCSI name of the compute port.
REST API: GET /v1/objects/ports
CLI: port_list
Obtain information about the intended compute port.
Run either of the following commands with the compute port ID specified.
If you use the CLI, you can specify the WWN or iSCSI name instead of the compute port ID.
REST API: GET /v1/objects/ports/<id>
CLI: port_show
Modifying settings of compute ports (CLI or REST API)
Modify the settings of the intended compute port.
To use an iSNS server, make settings for the iSNS server.
Internet Storage Name Service (iSNS) is a naming service for iSCSI. By using iSNS, information about the initiator and the target (IP address, TCP port number, iSCSI name, etc.) can be discovered without any settings.
-
For the server address specified when registering an iSNS server, specify a network in the same segment that can be connected to the compute port.
-
If two compute ports exist on a storage node, both ports must have the same settings for the iSNS client function (such as enable/disable of the iSNS client function and information of the connection-target iSNS server). If different settings are used, information might not be correctly applied to the iSNS server.
-
Even when correct information is set, not all iSCSI targets might be correctly recognized in combinations of control ports and some iSNS servers. In such a case, add individual iSCSI targets manually.
With iSNS enabled in Virtual Storage Software block, the following are supported by connecting with the iSNS server:
(1) Naming service
iSNS registers the initiator/target information on the network with the iSNS database and makes inquiries to the iSNS database at the request of the initiator or target.
(2) SCN (State Change Notification)
An SCN is a message to notify the initiator or target of changes in the iSNS database. When the initiator or target registers an SCN notification request, iSNS sends an SCN to the registered peer.
(3) ESI (Entity Status Inquiry)
iSNS supports ESI (Entity Status Inquiry), a heartbeat feature for the initiator and target. More specifically, iSNS sends an "ESI" to the initiator and target periodically. If no response is received for a certain number of ESIs due to a network failure or other failure, iSNS unregisters the initiator and target from the iSNS database.
When the type of compute ports is "target", all compute ports are registered with the iSNS server.
The following table lists the attributes registered in the iSNS server in the naming service.
Attribute name |
Registration required |
Attribute value type |
Attribute value length |
Description |
Delimiter |
- |
Value |
0 |
Delimiter. Used in a delimiter attribute. |
Entity Identifier (EID) |
Key |
Character string |
256 |
ID specifying an entity uniquely. Generated from a MAC address. Unique value for each physical port. The setting cannot be changed. The following defaults are set. iqn.1994-04.jp.co.hitachi:rsd.sph.t.XXXXX.YYY XXXXX: Serial number (0x0 to 0xFFFFF) YYY: Port number (0x0 to 0xFFF) |
Entity Protocol |
A |
Value |
4 |
Specify "2". |
IP address |
Key |
IP address |
16 |
Specify the IP address of the port. |
Portal TCP/UDP Port |
Key |
Value |
4 |
Specify the port number of the port. |
ESI Interval |
A |
Value |
4 |
ESI issuance interval (in seconds). Set 300 seconds. |
ESIPort |
Key |
Value |
4 |
ESI receive port number. Specify the value obtained when enabling the iSNS service for ISP4022. |
SCNPort |
Key |
Value |
4 |
SCN receive port number. Specify the value obtained when enabling the iSNS service for ISP4022. |
iSCSI Name |
Key |
Character string |
224 |
Specify the iSCSI name of the iSCSI target. |
iSCSI Node Type |
A |
Value |
4 |
Specify "Target" (0x00000001). |
iSCSI Node Alias |
Key |
Character string |
256 |
Specify the iSCSI alias of the iSCSI target. |
iSCSI Node SCN Bitmap |
Key |
Value |
4 |
Information received via an SCN. Set only bit 25 to ON to receive only the target information. |
Key: Registered key attribute, A: Registered attribute |
Before you begin
Required role: Storage
Procedure
Verify the ID of the intended compute port.
If you use the CLI to specify a compute port by WWN or iSCSI name, check the WWN or iSCSI name of the compute port.
REST API: GET /v1/objects/ports
CLI: port_list
Modify the settings of the intended compute port.
Run either of the following commands with the compute node ID specified.
If you use the CLI, you can specify the WWN or iSCSI name instead of the compute port ID.
Set a nickname and iSCSI name (for iSCSI connection), and then perform settings for FC (network connection) or iSCSI.
In iSNS settings, enable or disable the iSNS client function and perform settings for the iSNS server.
Nickname
-
Each compute port must have a unique nickname.
-
Conventions to be followed when setting a nickname
-
Number of characters: 1 to 32
-
Characters that can be used: Numbers (0 to 9), uppercase alphabet (A to Z), lowercase alphabet (a to z), symbols (! # $ % & ' + - . = @ ^ _ { } ~ ( ) [ ] :)
-
iSCSI name
-
The same iSCSI name as another compute port cannot be set.
-
The default name of the compute port added when a storage node is added cannot be set.
Example: iqn.1994-04.jp.co.hitachi:rsd.sph.t.<ID-of-the-storage-cluster>.XXX
Where, <ID-of-the-storage-cluster> is the hexadecimal notation of internalId obtained in Obtaining information about storage clusters.
REST API: PATCH /v1/objects/ports/<id>
CLI: port_set
Verify the job ID which is displayed after the command is run.
-
Verify the state of the job.
Run either of the following commands with the job ID specified.
REST API: GET /v1/objects/jobs/<jobId>
CLI: job_show
If the job state is "Succeeded", the job is completed.
Obtain information about the intended compute port and verify the settings of the compute port.
Run either of the following commands with the compute port ID specified.
If you use the CLI, you can specify the WWN or iSCSI name instead of the compute port ID.
REST API: GET /v1/objects/ports/<id>
CLI: port_show
Back up the configuration information.
Perform this step by referring to Backing up the configuration information.
If you continue operations with other procedures, you must back up the configuration information after you have completed all operations.