vxdctl (1M)

NAME

vxdctl - control the volume configuration daemon

SYNOPSIS

vxdctl bootdg group

vxdctl cmdcompletion {enable|disable}

vxdctl debug {[tagged=]level [pathname] | get}

vxdctl defaultdg diskgroup

vxdctl disable

vxdctl [-f] enable

vxdctl hostid hostid

vxdctl init [hostid]

vxdctl initdmp

vxdctl license [init]

vxdctl list

vxdctl [-c] mode

vxdctl protocolrange

vxdctl protocolversion

vxdctl request_threads [count]

vxdctl [-F] set attribute[=value]

vxdctl setversion [version]

vxdctl [-k] stop

vxdctl support

vxdctl transstate

vxdctl [-F] unset attribute

vxdctl upgrade

DESCRIPTION

The vxdctl utility manages aspects of the state of the volume configuration daemon, vxconfigd, sets the default disk group for the system, and also sets up the boot disk group if the root disk is under Veritas Volume Manager (VxVM) control.

The volboot file forms a key element in managing the state of vxconfigd and importing the boot disk group. This file contains a host ID that VxVM uses to establish ownership of physical disks. The host ID is used to ensure that two or more hosts do not interfere with each other when accessing disks on a shared SCSI bus or Storage Area Network (SAN). VxVM also uses host IDs to generate unique ID strings for stamping disks and disk groups.

The volboot file contains the name of the system-wide default disk group if this has been configured. If the root disk is under VxVM control, the volboot file also contains the name of disk group, the boot disk group, to which the root disk belongs.

Note: The purpose of the cluster environment is to allow hosts that can access disks on a shared bus to do so in a coordinated way. In this environment, the host ID is not used to prevent shared access; however, it is used for other internal functions.

vxconfigd operates in one of the following modes: enabled or disabled.

The enabled state is the normal operating state. Most configuration operations are allowed in this state. Entering the enabled state imports all disk groups, and begins the management of device nodes stored in the /dev/vx/dsk and /dev/vx/rdsk directories.

In the disabled state, vxconfigd does not retain configuration information for the imported disk groups, and does not maintain the volume device directories. Most operations are disallowed in this state. Certain failures, such as the volboot file not being loaded or devices not being auto-configured, cause vxconfigd to enter the disabled state automatically.

The action performed by vxdctl depends upon the specified keyword operand(s).

KEYWORDS

bootdg group
  Sets the boot disk group to the specified disk group. The boot disk group is the disk group that contains the volumes that are used to boot the system. The vxdctl bootdg command also adds an entry into the volboot file for the specified disk group as the boot disk group.
cmdcompletion
  By default, you can use the command completion feature by invoking the bash shell on every log in. If you want to permanently enable the command completion, use the cmdcompletion enable command. The enable operation creates the .bash_profile file, if not present. The cmdcompletion disable operation disables the feature permanently.
debug Sets the vxconfigd debugging log level or tagged message level from 0 to 9. If set to 0, debugging log or tagged message output is disabled. If a pathname is specified, debug output is directed to this file. Use the get keyword to display the current level.
defaultdg Specifies the system-wide default disk group that is aliased by the reserved name, defaultdg. You can use the command vxdg defaultdg to display the currently defined default disk group.
If bootdg is specified as the argument to this command, the default disk group is set to be the same as the currently defined system-wide boot disk group. You can use the command vxdg bootdg to display the currently defined boot disk group.
If nodg is specified as the argument, the default disk group is undefined.
Note: The specified disk group need not currently exist on the system.
disable Requests that vxconfigd enter disabled mode. This may be necessary to perform some maintenance operations. This does not disable any configuration state loaded into the kernel. It only prevents further configuration changes to loaded disk groups until vxconfigd is re-enabled.
enable Requests that vxconfigd enter enabled mode, import all disk groups, and rebuild the volume device node directories. This operation can be used even if vxconfigd is already in enabled mode. The primary purpose for using this operation when in enabled mode is to rebuild the volume device nodes. This operation causes vxconfigd to scan for any disks that were newly added since vxconfigd was last started. In this manner, disks can be dynamically configured to the system and then recognized by VxVM. If the multipathing support is available, this option also causes vxconfigd to rebuild the DMP internal database to reflect the new state of the system after addition of the disk devices. The new disk devices detected by vxconfigd are added in the DMP database with their associated subpaths and parent DMP device.
By default, VxVM performs a full scan of the device tree when performing device discovery. To discover only newly added disks that are not already known to VxVM, specify the -f option.
hostid Changes the host ID in the volboot file, and on all disks in disk groups currently imported on this machine. It may be desirable to change the VxVM host ID for your machine if you change the network node name of your machine.
If some disks are inaccessible at the time of a hostid operation, it may be necessary to use the vxdisk clearimport operation to clear out the old host ID on those disks when they become reaccessible. Otherwise, you may not be able to re-add those disks to their disk groups.
Note: Be careful when using this command. If the system crashes before the hostid operation completes, some disk groups may not reimport automatically.
init Reinitializes the volboot file with a new host ID, highest supported cluster protocol version, system-wide default disk group name, and boot disk group name (if the root disk is under VxVM control).
If a hostid operand is specified, this string is used; otherwise, a default host ID is used. The default host ID is normally taken as the network node name for the host (see uname(1M)). On systems with a hardware-defined system ID, the default host ID might be derived from this hardware ID.
initdmp Creates user-level DMP metanodes for all DMP devices that the kernel has detected. If a DMP metanode is missing, a new node is created. If a DMP metanode already exists, the node is not touched.
license [init]
  Without any arguments, the vxdctl license command prints the list of features which are currently available based on known licensing information.
Note: If only a Base VxVM license is installed, the vxdctl license command displays "DMP (single path enabled)". If either the Full VxVM license or an automatically generated license (such as that for the PHOTON array) is installed, the command displays "DMP (multipath enabled)".
With the init argument specified, the vxdctl license init command requests that vxconfigd re-read any persistently stored license information. If licenses have expired, this can make some features unavailable. If new licenses were added, but are not yet recognized by vxconfigd, this command forces vxconfigd to rescan the licenses, and to make the new licenses available.
After you change product levels with the vxkeyless command or the License option of the installer, run the vxdctl license init command to rescan the licenses. If you do not run the command, the VxVM information about licenses may be stale.
list Lists the contents of the volboot file including the host ID, some sequence numbers, the cluster protocol version, the name of the system-wide default disk group (if any), the name of the boot disk group (if the root disk is under VxVM control), and the site name (if defined).
mode Prints the current operating mode of vxconfigd. The output format is:

mode: operating_mode
where operating_mode is one of enabled, disabled, booted, or not-running.
The -c flag displays whether the system is in a Cluster Volume Manager (CVM) cluster, and if so, whether the system is the CVM master node or a CVM slave node. This information is only available when vxconfigd is in the enabled mode on a CVM cluster. The output format is:

mode: enabled: clustered_state
where clustered_state is one of cluster inactive, cluster active - role not set, cluster active - MASTER, cluster active - SLAVE.
protocolrange
  Print the cluster protocol range supported by the node. The output format is:

minprotoversion: minimum protocol version, \ maxprotoversion: maximum protocol version
protocolversion
  Prints the current cluster protocol version of the node. The output format is:

cluster running at protocol protocolversion
The protocolversion is a value in the range listed by vxdctl protocolrange. This information is only available if the VxVM cluster feature is enabled.
request_threads [count]
  Indicates the maximum number of threads available to process requests from various clients. If count is specified, sets the number of threads. If count is not specified, the request_threads command displays the number of threads currently available to process requests from the clients.
set attribute[=value]
  Defines an attribute and associated value. Currently, the only supported attribute is site, which is used to define the name of the site where the system is located. This site name is stored in the volboot file, and is used to implement Remote Mirror solutions and the site_read_local preferred plex read policy of the vxvol command.
If a site name is already defined for any imported disk groups, the operation fails unless the -F option is specified.
setversion version
  Sets the protocol version inside the volboot file. This command must be run when the node is not joined into the cluster. The command fails if the node is currently in a cluster.
If specified, the version must be within the protocol version range. If version is not specified, the command displays the current version specified in the volboot file.
support Displays information about the versions of VxVM objects and components that are supported by the configuration daemon that is currently running. Versions are printed as colon-separated name/value pairs:
vxconfigd_vrsn Version of vxconfigd that is currently running.
dg_minimum Lowest disk group version supported by vxconfigd.
dg_maximum Highest disk group version supported by vxconfigd.
kernel Highest kernel version supported by vxconfigd.
protocol_minimum Lowest cluster protocol version supported by the node.
protocol_maximum Highest cluster protocol version supported by the node.
protocol_current Cluster protocol version currently running on the node.
The protocol version information is only meaningful for the VxVM cluster feature.
stop Requests that vxconfigd exit. This may be necessary to reset VxVM, such as when the -r reset option is specified to vxconfigd. This command does not disable any configuration state that is loaded into the kernel. It only affects the ability to make configuration changes until vxconfigd is restarted. If the -k option is used, vxconfigd is stopped by sending it a SIGKILL signal. The command pauses for up to one second to verify that vxconfigd has exited. It returns an error if vxconfigd has not exited after one second’s delay has elapsed.
transstate Displays the shared transaction status of the node on which the command is executed.
If run on the MASTER node, the transaction state displays one of the following states:

transaction state: ready
transaction state: not ready


If run on the SLAVE node, the transaction state displays as follows:

transaction state: not the MASTER


If a node is not a part of the cluster, the transaction state displays as follows:

transaction state: cluster inactive


unset Removes an attribute from the volboot file. Currently, the only supported attribute is site, which is used to define the name of the site where the system is located. If the site name is already defined for any imported disk groups, the operation fails unless the -F option is specified.
upgrade Requests that the cluster be upgraded to the highest cluster protocol possible. This option is only available if the VxVM cluster feature is enabled.
Upgrade the cluster protocol version only after the packages on all nodes in the cluster have been upgraded. After the cluster protocol version is upgraded, only nodes using the latest software version can join the cluster. The vxdctl upgrade command can be run from the master node or a slave node. In most cases, Symantec recommends that you run the command from the master node.
The vxdctl upgrade command changes the protocol version in the volboot file. To view the current protocol version, use the vxdctl list command or the vxdctl protocolversion command. To view the supported protocol versions for the host, use the vxdctl protocolrange command or the vxdctl support command.

FILES

/etc/vx/volboot File containing miscellaneous boot information.
/etc/vx/darecs File containing a list of disks to be scanned and configured, which are to be persistent across bootloads. Normally, disks are auto-configured and do not need to be added to the darecs file. Under rare circumstances (for example, solid state disks), some disks are not recognized automatically. In these cases, you can define the disks in the darecs file.

NOTES

From release 4.0 of VxVM, the add disk and rm disk commands are no longer supported.

SEE ALSO

fsck(1M), uname(1M), vxconfigd(1M), vxdg(1M), vxdisk(1M), vxdmp(7), vxintro(1M), vxlicinst(1), vxlicrep(1)


VxVM 6.0.1 vxdctl (1M)