Home > Veritas Storage Foundation™ for DB2 Manual Pages
VAILDIAG (1) |
User Commands |
vaildiag configures VERITAS Array Integration Layer (VAIL) providers to manage storage arrays.
The operations that can be fired using vaildiag fall under two categories.
/PROVIDERS : Lists the vail providers running on the agent.
/RESCAN : Rescans the specified storage array(s).
/SHOWARRAYS : Displays the list of discovered/configured arrays.
/ADDARRAY : Configures an new array for discovery.
/MODIFYARRAY : Changes configuration parameters for an array.
/REMOVEARRAY : Unconfigures the specified array.
/SETDEFPOLLINGINT : Sets the default polling interval.
/SHOWDEFPOLLINGINT : Displays the default polling interval.
/CHANGEPASSWORD : Changes the logon password of the specified array.
/SETOPTIONALPROVPARAM : Enables setting Provider specific optional parameters.
/GETOPTIONALPROVPARAM : Displays the Provider specific optional parameters.
/SHOWTASKS : Lists the running tasks.
/SETPURGEPERIOD : Specifies how long to retain information about a task.
/ADDARRAYPROVIDER : Adds a provider to the specified agent.
/REMOVEARRAYPROVIDER : Removes a provider from the specified agent.
/JOINDOMAIN : Attaches the agent to the default domain.
/LISTARRAYPROVIDERS : List the providers under the specified agent.
/LISTAGENTS : Lists the VAIL agents configured in the PAL Registry.
/UNCONFIGUREAGENT : Unconfigures the VAIL agent from the PAL Registry.
/ENABLEAUTOSTART : Enables VAIL agent auto-start at system reboot/start.
/DISABLEAUTOSTART : Disables VAIL agent auto-start at system reboot/start.
Creates a connection to the target Agent on the local host. This option is used in association with another command of the "Array Configuration Option" type (described below). The /CONNECT option specifies the connection parameters for the target Agent. On successful connection to the Agent, the "Array Configuration" command (indicated by /ARRAY-COMMAND in the Synopsis above) will be executed on the Agent.
-agentname AgentName specifies the Agent to connect to, where AgentName is the name of the Agent.
-agentport AgentPortNumber specifies the portnumber of the agent on the host.
Note: The connect option is compulsory for array configuration commands.
The following is an example of using /CONNECT to display a list of VAIL providers installed on the local host:
# ./vaildiag /CONNECT -agentname VAILAgent /PROVIDERS
Enter the Agent Port Number: 2149
Sample client connected successfully
Connecting to local host
Provider : vx_ibmshark
Provider : vx_hp_eva
Provider : vx_hicommand
Provider : vx_emc_symmetrix
Provider : vx_emc_clariion
Provider : vx_ibmds8000
#
The following commands (indicated by /ARRAY-COMMAND in the Synopsis above) perform Array Configuration on the specified Agent. The /CONNECT switch needs to be specified along with these commands to specify the connection related parameters for the Agent.
-all rescans all arrays discovered by all the providers.
-provider ProviderName rescans storage arrays for updated status. The storage arrays that are rescanned are those that are managed by the VAIL provider specified by ProviderName. Issue vaildiag /PROVIDERS to obtain the names of the providers loaded on the host.
-array ArrayID optional parameter along with the providername to rescans the array specified by ArrayID for the given providername. When you specify an array ID, you must also specify -provider ProviderName. You can obtain Array IDs for the discovered storage arrays by issuing the vaildiag /SHOWARRAYS command. You can obtain provider names for the providers loaded on the host by issuing the vaildiag /PROVIDERS command.
[-provider ProviderName]
Displays a list of storage arrays discovered by the VAIL provider on the agent connected to the providers that match the specified criteria. You can display all arrays, arrays in a normal or unhealthy state or configured arrays. You can display arrays for all providers or, optionally, arrays managed by a specified VAIL provider.
-configured lists all configured storage arrays discovered by the VAIL provider on the agent. A configured array is an in-band storage array that is discovered by a VAIL provider or an out-of-band array that is added to a VAIL provider for management. An out-of-band array could be configured but not yet discovered by the VAIL provider.
You can optionally specify -provider ProviderName for a list of configured arrays managed by a specific VAIL provider.
-all lists all discovered storage arrays discovered by the VAIL provider. A configured out-of-band array is not discovered by the VAIL provider until a rescan is issued for the array or the provider.
You can optionally specify -provider ProviderName for a list of all discovered arrays managed by a specific VAIL provider.
-normal lists all discovered storage arrays that are not in an error or warning state.
You can optionally specify -provider ProviderName for a list of normal arrays managed by a specific VAIL provider.
-unhealthy lists all discovered storage arrays that are in an error or warning state.
You can optionally specify -provider ProviderName for a list of unhealthy arrays managed by a specific VAIL provider.
-provider ProviderName lists all configured storage arrays managed by the VAIL provider specified by ProviderName. The names of the VAIL providers loaded on the host can be obtained by issuing the vaildiag /PROVIDERS command.
-username UserName -password Password
[-encoding EncodingMethod]
[-pollinginterval minutes]
[-optionalparam OptionalParameters]
Adds a storage array to be managed by the specified VAIL provider. You can specify a user name and password to log on to the array, if required, and any optional parameters used by the storage array. You can also specify a polling interval, which determines how often the VAIL provider queries this array for status changes. After you add the array, issue the vaildiag /RESCAN command to discover the added array.
-provider ProviderName specifies the VAIL provider to manage the storage array. To obtain a list of VAIL providers on the host, issue the PROVIDERS command.
-arrayid ArrayID specifies the array to add. ArrayID can be either the IP address or the name of the array being added. If the storage array requires the VAIL provider to specify a port number to communicate with the array, you can optionally specify -arrayid ArrayID:PortNumber where PortNumber identifies the port the provider uses for communication.
-username UserName specifies the user name to log on to the storage array.
-password Password specifies the password to log on to the storage array. The password is displayed if you use this option. To avoid displaying the password, do not specify the -password option. vaildiag then prompts for the password, which it does not echo.
-encoding EncodingMethod specifies the encoding used for the password. Currently unused.
-pollinginterval minutes specifies, in minutes, how often the VAIL provider queries this storage array for status changes. If you do not specify this parameter, if you enter 0, or if you enter an invalid value, the default polling interval for the VAIL provider is used. The minimum interval is 1 minute. Use the provider default value unless your array requires a longer polling interval.
-optionalparam OptionalParameters specifies optional parameters used by some storage arrays. For example:
-optionalparam "SNMPReadCommunity=public,SNMPWriteCommunity=public"
-orgarrayid OriginalArrayId -arrayid ArrayID
-username UserName [-pollinginterval minutes]
[-optionalparam OptionalParameters]
Changes information about a storage array that is managed by a provider. You can use this command to change the user name to log on to the storage array, to change the polling interval for the array, or change optional parameters. You can also use this command to change the array ID. After you modify the array, issue the vaildiag /RESCAN command to rediscover the array.
-provider ProviderName specifies the provider that is managing the storage array. To obtain a ProviderName list for all providers on the host, issue the vaildiag /PROVIDERS command.
-orgarrayid OriginalArrayId identifies the array whose information you are changing. This is the array ID that you specified when you added the storage array to the provider using the vaildiag /ADDARRAY command. OriginalArrayId can be either the IP address or the name of the array. You can get a list of array IDs for managed arrays by using the SHOWARRAYS command.
-arrayid ArrayID if you are changing the array ID, this parameter specifies the new array ID. ArrayID can be either the IP address or the name of the array. If the storage array requires the provider to specify a port number to communicate with the array, you can optionally specify -arrayid ArrayID:PortNumber where PortNumber identifies the port the provider uses for communication.
-username UserName specifies the new user name to log on to the storage array if you are changing the user name. Issue the vaildiag /CHANGEPASSWORD command if the new user name has a different password.
-pollinginterval minutes specifies, in minutes, how often the provider queries this storage array for status changes. The minimum interval is 1 minute. Use the provider default value unless your array requires a longer polling interval.
-optionalparam OptionalParameters specifies new optional parameters used by some storage arrays if you are changing a storage array's optional parameters.
-optionalparam "SNMPReadCommunity=public,SNMPWriteCommunity=public"
Removes the specified out-of-band storage array from management by the specified provider. After you issue the REMOVE option, issue the vaildiag /RESCAN command to remove the array.
-provider ProviderName specifies the provider that is managing the storage array. To obtain a ProviderName list for all providers on the host, issue the vaildiag /PROVIDERS command.
-arrayid ArrayID specifies the array to remove. ArrayID can be either the IP address or the name of the array being removed. An ArrayID list for the managed storage arrays attached to the server can be obtained by issuing the vaildiag /SHOWARRAYS command.
-pollinginterval minutes
Sets the default polling interval, in minutes, used by the specified provider. This interval is used if you do not set a polling interval, enter 0, or enter an invalid interval for a storage array that is managed by this provider. The minimum interval is 1 minute; if you enter 0, or an invalid value, or do not set this parameter, the provider built-in interval of 30 minutes is used. Use the built-in value unless your arrays requires a longer polling interval.
-provider ProviderName specifies the provider whose default polling interval you are setting. To obtain a ProviderName list for all providers on the host, issue the vaildiag /PROVIDERS command.
-pollinginterval minutes specifies the default polling interval for the provider.
The minimum interval is 1 minute; the built-in value is 30 minutes.
Displays the default polling interval, in minutes, for the specified provider. This interval is used if you do not set a polling interval or enter an invalid interval for a storage array that is managed by this provider.
-provider ProviderName specifies the provider whose default polling interval you are displaying. To obtain a ProviderName list for all providers on the host, issue the vaildiag /PROVIDERS command.
-password Password [-encoding EncodingMethod]
Changes the password to log on to the specified array.
-provider ProviderName specifies the provider that manages the storage array whose password you are changing. To obtain a ProviderName list for all providers on the host, issue the vaildiag /PROVIDERS command.
-arrayid ArrayID specifies the array ID of the storage array whose password you are changing. ArrayID can be either the IP address or the name of the array. An ArrayID list for the managed storage arrays attached to the server can be obtained by issuing the vaildiag /SHOWARRAYS command.
-password Password the new password to log on to the storage array. The password is displayed if you use this option. To avoid displaying the password, do not specify the -password option. vaildiag then prompts for the password, which it does not echo.
-encoding EncodingMethod specifies the encoding used for the password. Currently unused.
Value1] [-parameter2 Value2][]
Enables setting optional parameters for a provider. Optional parameters are specific to each provider. To obtain a ProviderName list for all providers on the host, issue the vaildiag /PROVIDERS command.
-provider ProviderName specifies the provider whose parameters you are setting.
-parameter1 Value1 -parameter2 Value2 specify parameter key/value pairs that you are setting for the specified provider.
The following example specifies a CLI path for an array provider that uses a CLI to communicate with storage arrays:
C:/vaildiag.exe /SETOPTIONALPROVPARAM -provider vxExampleProvider -cliexepath "C:/ExampleProvider CLI1"
The following example specifies a JRE path for an array provider (CLARiiON) that requires the path:
vaildiag /SETOPTIONALPROVPARAM -provider vx_emc_clariion -JavaExePath c:\Program Files\Java\j2re1.4.2\bin
The following example specifies the path to an array configuration file for an array provider (EMC Symmetrix) that requires the path. If the path contains blanks, enclose the path in double quotes ("):
vaildiag /SETOPTIONALPROVPARAM -provider vx_emc_symmetrix -discoverarraysfile "/tmp/select arrays.txt"
Displays the optional parameters for the specified provider. You can issue GETOPTIONALPROVPARAM to display a list of the optional parameter names.
-provider ProviderName specifies the provider whose parameters you are displaying. To obtain a ProviderName list for all providers on the host, issue the vaildiag /PROVIDERS command.
Displays the specified task types for all providers or, optionally, for the specified provider. Generally, tasks are array management functions that take a noticable time to complete. You can use this command to check the progress of tasks.
-all displays all tasks
-done displays only tasks that have completed
-inprogress displays only tasks that have started, but not completed
Specifies how long to retain information about a task after the task has completed. You cannot display information about a completed task after the purge period expires for that task.
-period minutes specifies time, in minutes, to retain information about a task after it completes.
These commands can be used to configure VAIL Providers under Agents in the PAL registry. This allows the user to run a selected group of VAIL Providers as one agent, thereby providing isolation and added control. These commands can only operate on the PAL Registry on the local host, and can not be used for Agent configuration on remote hosts. It is strongly recommended that the Agents, being operated upon, should be stopped before modification. These commands do not require the /CONNECT switch as they operate on the local PAL Registry, and do not communicate with any Agent as such. The modified Agent should be restarted for the changes to take effect. The commands in this category (indicated by /AGENT-COMMAND in the Synopsis above) are as follows;
-provider ProviderName [-createagent]
Configures the specified provider under the specified agent. If the specified agent is not configured, a prompt is given and accordingly the agent along with the provider are configured.
-agentname AgentName specifies the agent under which the provider is to be configured. To obtain the list of all the vailagents configured on the host, issue the vaildiag /LISTAGENTS command.
-provider ProviderName specifies the provider which is to be configured. To obtain the list of all the providers configured under an agent, issue the vaildiag /LISTARRAYPROVIDERS -agentname AgentName.
-createagent This is an optional parameter, which specifies that the agent should be configured, if not already configured.
-provider ProviderName [-removeagent]
Unconfigures the specified provider from the specified agent.
-agentname AgentName specifies the agent from which the provider is to be unconfigured. To obtain the list of all the vailagents configured on the host, issue the vaildiag /LISTAGENTS command.
-provider ProviderName specifies the provider that is to be unconfigured. To obtain the list of all the providers configured under an agent, issue the vaildiag /LISTARRAYPROVIDERS -agentname AgentName.
-removeagent This is an optional paramter, which specifies that the agent should be unconfigued, if the agent does not contain any configured provider under it after unconfiguring the specified provider.
Provides the list of Providers configured under the specified agent.
-agentname AgentName specifies the agent whose providers are to be listed.
-adminpasswd AdministratorPassword] | [-standalonemode]]
Attaches the specified agent to the default domain.
-agentname AgentName specifies the agent which is to be attached to the default domain. To obtain the list of all the vailagents configured on the host, issue the vaildiag /LISTAGENTS command.
-password Password specifies the password for private account of the agent. This is an optional parameter, which needs to be specified if the configuration is not Host Controller mode (stand-alone-mode). The password is displayed if you use this option. To avoid displaying the password, do not specify the -password option. vaildiag then prompts for the password, which it does not echo.
-adminpasswd AdministratorPassword specifies the security administrator's password. This is an optional parameter, which needs to be specified if the configuration is not Host Controller mode (stand-alone-mode). The password is displayed if you use this option. To avoid displaying the password, do not specify the -adminpasswd option. vaildiag then prompts for the password, which it does not echo.
-standalonemode This is a optional parameter, which needs to be specified in case of Host controller mode configuration (stand alone mode). The "password" and "adminpasswd" parameters are not required to be specified in this case.
Provides the list of vail agents configured on the local host.
[-leavedomain -adminpasswd AdministratorPassword]
Unconfigures the specified agent from the PAL registry.
-agentname AgentName specifies the agent which is to be unconfigured from the PAL registry. If the agent is a VAIL agent and does not contain any VAIL providers configured under, the agent will be unconfigured. But if the agent contains VAIL providers configured, it will not be unconfigured until the optional "-force" parameter is used along with this command. In case the agent is not a VAIL agent, it cannot be unconfigured using this command. To obtain the list of VAIL agents configured on the host, issue the vaildiag /LISTAGENTS command.
-force This is an optional paramter, which specifies that the VAIL agent be unconfigured even if the agent has VAIL providers configured under itself.
-leavedomain Optional parameter, which specifies to unconfigure the agent from the default domain controller before unconfiguring the agent from the local host.
-adminpasswd If the -leavedomain option is specified, then the administrator password needs to be specified to unconfigure the agent from the domain controller.
Enables VAIL agent auto-start during system reboot/start.
-agentname AgentName specifies the agent which is to be auto-started during system reboot/start. To obtain the list of all the vailagents configured on the host, issue the vaildiag /LISTAGENTS command.
Disables VAIL agent auto-start at system reboot/start.
-agentname AgentName specifies the agent which is to be disabled from auto-start during system reboot/start. To obtain the list of all the vailagents configured on the host, issue the vaildiag /LISTAGENTS command.
Example 1: Adding Hewlett-Packard StorageWorks EVA arrays for discovery
vaildiag /CONNECT -agentname <name_of_agent> -agentport <portnumber_of_agent> /ADDARRAY -provider vx_hp_eva -arrayid <ip_address_of_CommandView_EVA_host> -username <username_to_log_onto_CommandView_EVA> -password <password_to_log_onto_CommandView_EVA\>
The parameters are explained below -
agentname - Agent containing the vx_hp_eva provider, to which we are adding new arrays for discovery. Typically, this would be "VAILAgent".
agentport - Port number used by the agent for communicating. Typically, this would be "1556".
provider - Provider managing the OpenView Storage Operations Manager (CommandView EVA). Set it to "vx_hp_eva".
arrayid - IP address, host name, or fully qualified domain name of the host where OpenView Storage Operations Manager (CommandView EVA) is installed
username - username to log on to OpenView Storage Operations Manager (CommandView EVA). Typically, this would be "administrator" for the HP EVA arrays.
password - password to log on to OpenView Storage Operations Manager (CommandView EVA).
Example 2: Adding an EMC CLARiiON array for discovery
We need to use the array configuration command /ADDARRAY along with the /CONNECT command for adding EMC CLARiiON arrays. Issue a command similar to the following to add arrays for discovery:
vaildiag /CONNECT -agentname <name_of_agent> -agentport <portnumber_of_agent> /ADDARRAY -provider vx_emc_clariion -arrayid <ip_address_of_CLARiiON_array_host>
The parameters are explained below -
agentname - Agent containing the vx_emc_clariion provider to which we are adding new arrays for discovery. Typically, this would be "VAILAgent".
agentport - Port number used by the agent for communicating. Typically, this would be "1556".
provider - Provider managing the EMC CLARiiON array. Set it to "vx_emc_clariion".
arrayid - IP address, host name, or fully qualified domain name of one of the array Storage Processors.
If you also want to discover and manage metaLUNS in the CLARiiON array, specify the following additional parameters:
username - username to log on to the EMC CLARiiON array
password - password to log on to the EMC CLARiiON array
vaildiag /CONNECT -agentname <name_of_agent> -agentport <portnumber_of_agent> /ADDARRAY -provider vx_emc_clariion -arrayid <ip_address_of_clariion_host> -username <username_to_log_onto_CLARiiON_array\> -password <password_to_log_onto_CLARiiON_array\> -optionalparam PeerSpName=<IP_of_second_SP>
Example 3: Adding Hitachi HiCommand Arrays for discovery
The following Hitachi arrays are managed through the HiCommand framework:
Hitachi Freedom Storage Lightning 9900V Series 9970V and 9980V Storage Arrays
Hitachi Freedom Storage Thunder 9500V Series Storage Arrays
Hitachi Freedom Storage Thunder 9200 Storage Arrays
vaildiag /CONNECT -agentname <name_of_agent> -agentport <portnumber_of_agent> /ADDARRAY -provider vx_hicommand -arrayid <ip_address_of_HiCommand_server> -username <username_to_log_onto_HiCommand_server\> -password <password_to_log_onto_HiCommand_server\>
The parameters are explained below -
agentname - Agent containing the vx_hicommand provider, to which we are adding new arrays for discovery. Typically, this would be "VAILAgent".
agentport - Port number used by the agent for communicating. Typically, this would be "1556".
provider - Provider managing the HiCommand server. Set this to "vx_hicommand".
arrayid - IP address, host name, or fully qualified domain name of the HiCommand server. If you want to change the default port (2001) that the provider uses to communicate with the HiCommand server, specify IPAddress:NewPortNumber.
username - username to log on to the HiCommand server
password - password to log on to the HiCommand server
Example 4: Adding IBM TotalStorage Enterprise Storage Server (ESS/Shark) arrays for discovery
vaildiag /CONNECT -agentname <name_of_agent> -agentport <portnumber_of_agent> /ADDARRAY -provider vx_ibmshark -arrayid <ip_address_of_ibmshark_host> -username <username_to_log_onto_ibmshark_array\> -password <password_to_log_onto_ibmshark_array\> -optionalparam "FailoverIP=<failover_IP_of_Specialist>"
The parameters are explained below -
agentname - Agent containing the vx_ibmshark provider, to which we are adding new arrays for discovery. Typically, this would be "VAILAgent".
agentport - Port number used by the agent for communicating. Typically, this would be "1556".
provider - Provider managing the Shark arrays. Set this to "vx_ibmshark".
arrayid - IP address, host name, or fully qualified domain name of the ESS Specialist
username - username to log on to the IBM ESS/Shark array.
password - password to log on to the IBM ESS/Shark array.
optionalparam - ESS Specialist failover IP address
Example 5: Adding IBM TotalStorage DS6000 and DS8000 Series storage arrays for discovery.
We need to use the array configuration command /ADDARRAY along with the /CONNECT command for adding IBM DS6000/DS8000 arrays. Issue a command similar to the following to add arrays for discovery:
vaildiag /CONNECT -agentname <name_of_agent> -agentport <portnumber_of_agent> /ADDARRAY -provider vx_ibmds8000 -arrayid <ip_address_of_ibmds8000_array> -username <username_to_log_onto_ibmds8000_array\> -password <password_to_log_onto_ibmds8000_array\>
The parameters are explained below -
agentname - Agent containing the vx_ibmds8000 provider, to which we are adding new arrays for discovery. Typically, this would be "VAILAgent".
agentport - Port number used by the agent for communicating. Typically, this would be "1556".
provider - Provider managing the IBM DS6000/8000 arrays. Set this to "vx_ibmds8000".
arrayid - IP address, host name, or fully qualified domain name of the DS6000/DS8000 arrays.
username - username to log on to the IBM DS6000/DS8000 array.
password - password to log on to the IBM DS6000/DS8000 array.
Example 6: Adding EMC Symmetrix arrays for discovery
All EMC arrays with a fibre channel connection to a host are discovered by that host if VAIL and the EMC Solutions Enabler are installed on the host. If you do not want to discover all arrays attached to a host, you can specify which arrays you want discovered.
Using a text editor, create a configuration file that contains the Symmetrix IDs of the arrays to discover. Specify each ID on a separate line in the file. Use vaildiag to input the path to the configuration file. The following example specifies the path to an array configuration file for the Symmetrix provider. If the path contains blanks, enclose the path in double quotes ("):
vaildiag /CONNECT -agentname <name_of_agent> -agentport <portnumber_of_agent> /SETOPTIONALPROVPARAM -provider vx_emc_symmetrix -discoverarraysfile <path_of_array_configuration_file>
The parameters are explained below -
agentname - Agent containing the vx_emc_symmetrix provider, to which we are specifying the path of configuration file. Typically, this would be "VAILAgent".
agentport - Port number used by the agent for communicating. Typically, this would be "1556".
provider - Provider managing the EMC Symmetrix arrays. Set this to "vx_emc_symmetrix".
discoverarraysfile - Path to an array configuration file for the Symmetrix provider. If the path contains blanks, enclose the path in double quotes ("). For example if the path is /tmp/select arrays.txt, specify -discoverarraysfile "/tmp/select arrays.txt" in the above command.
After you specify the path to the configuration file, the Symmetrix provider discovers only the arrays specified by the file. To reenable discovery of all attached Symmetrix arrays, delete the following entry under [HKEY_LOCAL_MACHINE/Software/VERITAS/VRTSobc/pal33/Agents/{VAIL_Agent_Name}/Providers/vx_emc_symmetrix] in the Registry:
[REG_SZ] "discoverarraysfile" = "<the_path_of_configuration_file_specified_in_the_command>";
By default, vaildiag resides in /opt/VRTSvail/bin on UNIX.
Copyright 2006 Symantec Corporation. All rights reserved.
Last updated: 17 April 2006
Copyright ©2009 Symantec Corporation
All rights reserved.