HMC Manual Reference Pages  - LABELVIOS (1)

NAME

labelvios - label Virtual I/O Servers

CONTENTS

Synopsis
Description
Options
Examples
Environment
Bugs
Author
See Also

SYNOPSIS

labelvios -o {a | r | s} -m managed-system [-l label]
[{-f input-data-file | -i "input-data"}] [--help]

DESCRIPTION

labelvios configures Virtual I/O Server (VIOS) Fibre Channel (FC) port labels or VIOS group labels, or changes the default VIOS label override settings on a managed system.

VIOS FC port labels are used for partition migration and partition remote restart operations. The same label names must be defined on both the source and destination VIOS FC ports used in the operation.

VIOS group labels are also used for partition migration and partition remote restart operations. The same label names must be defined on both the source and destination managed systems used in the operation.

OPTIONS

-o The operation to perform. Valid values are a to add a VIOS group label, r to remove a VIOS FC port label or one or more VIOS group labels, and s to configure a VIOS FC port label, to change the attributes of a VIOS group label, or to change the default VIOS label override settings for the managed system.
-m The name of the managed system for which to perform the operation. The name may either be the user-defined name for the managed system, or be in the form tttt-mmm*sssssss, where tttt is the machine type, mmm is the model, and sssssss is the serial number of the managed system. The tttt-mmm*sssssss form must be used if there are multiple managed systems with the same user-defined name.
-l The name of the VIOS FC port label to set, or the name of the VIOS group label to add, remove, or set.

When removing a VIOS group label, you can use this option to specify the name of the label to remove, or you can specify the resource attribute to remove all labels of the specified resource type.

This option is required when setting a VIOS FC port label, when adding a VIOS group label, and when changing the attributes of a VIOS group label. This option is optional when removing a VIOS group label. This option is not valid when removing a VIOS FC port label or changing the default VIOS label override settings.

-f The name of the file containing the input data for this command. The input data consists of attribute name/value pairs, which are in comma separated value (CSV) format.

The format of the input data is as follows:

attribute-name=value,attribute-name=value,...

Note that certain attributes accept a comma separated list of values, as follows:

attribute-name=value,value,... ,...

When a list of values is specified, the attribute name/value pair must be enclosed in double quotes. Depending on the shell being used, nested double quote characters may need to be preceded by an escape character, which is usually a ’#146; character.

If ’+=’ is used in the attribute name/value pair instead of ’=’, the specified value is added to the existing list. += can be used in set operations only.

If ’-=’ is used in the attribute name/value pair instead of ’=’, the specified value is deleted from the existing list. -= can be used in set operations only.

Attribute names for setting or removing a VIOS FC port label:
resource
Required
The only valid value is fcport for FC port
port_name
Required
FC port name
vios_names | vios_ids
Either vios_names or vios_ids is required
One VIOS name or one VIOS ID

Attribute names for adding a VIOS group label:
resource
Required
Resource type of the VIOS group
Valid values are:
msp - Mover Service Partition (MSP)
vfc - virtual Fibre Channel
vnic - virtual NIC
vscsi - virtual SCSI
type
Valid values are:
include - include the VIOS group in VIOS selection
(default value)
exclude - exclude the VIOS group in VIOS selection
(only valid for VIOS MSP groups)
vios_names
Comma separated list of one or more names of Virtual
I/O Servers to be in the group. Each entry has the
following format:

VIOS-name[/VIOS-IP-addresses]

The ’/’ character is optional, but it must be present
if VIOS-IP-addresses is present. VIOS-IP-addresses
can be present in VIOS MSP groups only.

VIOS-IP-addresses is a comma separated list of one
or more VIOS IP addresses to be in the VIOS MSP group.
It is optional for an include group and required for
an exclude group.

Either vios_names or vios_ids is required.
vios_ids
Comma separated list of one or more IDs of Virtual
I/O Servers to be in the group. Each entry has the
following format:

VIOS-ID[/VIOS-IP-addresses]

The ’/’ character is optional, but it must be present
if VIOS-IP-addresses is present. VIOS-IP-addresses
can be present in VIOS MSP groups only.

VIOS-IP-addresses is a comma separated list of one
or more VIOS IP addresses to be in the VIOS MSP group.
It is optional for an include group and required for
an exclude group.

Either vios_names or vios_ids is required.

Attribute names for setting a VIOS group label:
new_name
vios_names
Comma separated list of one or more names of Virtual
I/O Servers to be in the group, or added to or removed
from the group. Each entry has the following format:

VIOS-name[/VIOS-IP-addresses]

The ’/’ character is optional, but it must be present
if VIOS-IP-addresses is present. VIOS-IP-addresses
can be present in VIOS MSP groups only.

VIOS-IP-addresses is a comma separated list of one
or more VIOS IP addresses to be in the VIOS MSP group,
or added to or removed from the group. To remove the
MSP and all of its IP addresses from the group,
VIOS-IP-addresses does not need to be specified.
vios_ids
Comma separated list of one or more IDs of Virtual
I/O Servers to be in the group, or added to or removed
from the group. Each entry has the following format:

VIOS-ID[/VIOS-IP-addresses]

The ’/’ character is optional, but it must be present
if VIOS-IP-addresses is present. VIOS-IP-addresses
can be present in VIOS MSP groups only.

VIOS-IP-addresses is a comma separated list of one
or more VIOS IP addresses to be in the VIOS MSP group,
or added to or removed from the group. To remove the
MSP and all of its IP addresses from the group,
VIOS-IP-addresses does not need to be specified.

Attribute names for removing a VIOS group label:
resource
Resource type of the VIOS group labels to remove
Valid values are:
msp - all Mover Service Partition (MSP) group labels
vfc - all virtual Fibre Channel group labels
vnic - all virtual NIC group labels
vscsi - all virtual SCSI group labels
all - all VIOS group labels

Attribute names for changing the default VIOS label override settings:
fc_port_label_override
Specifies whether VIOS FC port labels are to be used
during partition migration and remote restart
operations:
1 - yes
2 - if possible (default value)
msp_label_override
Specifies whether VIOS MSP group labels are to be used
during partition migration and remote restart
operations:
1 - yes
2 - if possible (default value)
storage_label_override
Specifies whether VIOS virtual SCSI and virtual Fibre
Channel group labels are to be used during partition
migration and remote restart operations:
1 - yes
2 - if possible (default value)
vnic_label_override
Specifies whether VIOS virtual NIC group labels are to
be used during partition migration and remote restart
operations:
1 - yes
2 - if possible (default value)

Input data for this command can be specified with this option or the -i option. The -f and the -i options are mutually exclusive.

Input data is required when setting and removing a VIOS FC port label, adding a VIOS group label, changing the attributes of a VIOS group label, or changing the default VIOS label override settings for the managed system. Input data is optional when removing VIOS group labels.

-i This option allows you to enter input data on the command line, instead of using a file. Data entered on the command line must follow the same format as data in a file, and must be enclosed in double quotes.

Input data for this command can be specified with this option or the -f option. The -i and the -f options are mutually exclusive.

Input data is required when setting and removing a VIOS FC port label, adding a VIOS group label, changing the attributes of a VIOS group label, or changing the default VIOS label override settings for the managed system. Input data is optional when removing VIOS group labels.

--help Display the help text for this command and exit.

EXAMPLES

In the following examples nested double quote characters are preceded by an escape character (’#146;). The escape characters are required to run the commands locally on an HMC.

Set a VIOS FC port label:

labelvios -m sys1 -o s -l fcportA -i "resource=fcport,port_name=fc0,
vios_names=vios1"

Add a VIOS vSCSI group label:

labelvios -m sys1 -o a -l vscsiGroupA -i "resource=vscsi,
vios_names=vios1"

Add a VIOS vFC group label:

labelvios -m sys1 -o a -l vfcGroup1 -i "resource=vfc,\"vios_ids=1,2\""

Add a VIOS MSP exclude group label:

labelvios -m sys1 -o a -l msps1 -i "resource=msp,type=exclude,
\"vios_names=\"\"vios1/9.1.2.3,9.1.2.4\"\",vios2/9.1.2.5\""

Add VIOSs to a VIOS group label:

labelvios -m sys1 -o s -l vcsiGroupA -i "\"vios_names+=vios2,vios3\""

Remove an IP address from a VIOS MSP group label:

labelvios -m sys1 -o s -l msps1 -i "vios_names-=vios1/9.1.2.3"

Change the name of a VIOS group label:

labelvios -m 9080-HEX*1234567 -o s -l label1 -i "new_name=vfclabel"

Change the default VIOS MSP group label override:

labelvios -m sys1 -o s -i "msp_label_override=1"

Remove the FC port label for FC port fc0 on the VIOS with ID 1:

labelvios -m sys -o r -i "resource=fcport,port_name=fc0,vios_ids=1"

Remove the VIOS group label msps1:

labelvios -m sys1 -o r -l msps1

Remove all VIOS MSP group labels:

labelvios -m sys1 -o r -i "resource=msp"

ENVIRONMENT

None

BUGS

None

AUTHOR

IBM Austin

SEE ALSO

lslabelvios


Linux LABELVIOS (1) December 2022
Generated by manServer 1.07 from labelvios.1 using man macros.