UPDATE SERVER (Update a server defined for server-to-server communications)
Use this command to update a server definition.
Restriction: If this server is a source server for a virtual volume operation, changing any of these values can affect the ability of the source server to access and manage the data that is stored on the corresponding target server. Changing the server name by using the SET SERVERNAME command might have additional implications, varying by operating system. The following are some examples:
- Passwords might be invalidated
- Device information might be affected
- Registry information about Windows operating systems might change
Privilege class
To issue this command, you must have system privilege.
Syntax for:
- Enterprise configuration
- Enterprise event logging
- Command routing
- Storage agent
- Node replication source and target servers
- z/OS® media server
>>-UPDate--SERver--server_name----------------------------------> >--+-----------------------------+------------------------------> '-SERVERPAssword--=--password-' >--+--------------------------+--+------------------------+-----> '-HLAddress--=--ip_address-' '-LLAddress--=--tcp_port-' >--+----------------------+--+-------------+--------------------> '-COMMmethod--=--TCPIP-' '-URL--=--url-' >--+--------------------------+---------------------------------> '-ALLOWReplace--=--+-Yes-+-' '-No--' >--+-----------------------------+--+-----------------------+---> '-DESCription--=--description-' '-FORCESync--=--+-Yes-+-' '-No--' >--+------------------------------------+-----------------------> | (1) | '-------VALIdateprotocol--=--+-No--+-' '-All-' .-TRANSFERMethod--=--Tcpip--------. >--+-----------------+--+---------------------------------+---->< '-SSL--=--+-No--+-' '-TRANSFERMethod--=--+-Tcpip----+-' '-Yes-' | (2) | '-Fasp-----'
Notes:
- The VALIDATEPROTOCOL parameter applies only to storage agent definitions.
- The TRANSFERMETHOD parameter is available only on Linux x86_64 operating systems.
Syntax for virtual volumes
>>-UPDate--SERver--server_name--+-----------------------+-------> '-PAssword--=--password-' >--+--------------------------+--+------------------------+-----> '-HLAddress--=--ip_address-' '-LLAddress--=--tcp_port-' >--+----------------------+--+-------------+--------------------> '-COMMmethod--=--TCPIP-' '-URL--=--url-' >--+-------------------------+--+------------------------+------> '-DELgraceperiod--=--days-' '-NODEName--=--node_name-' >--+-------------+--+-----------------------+-------------------> '-SSL--=--Yes-' '-FORCESync--=--+-Yes-+-' '-No--' >--+-----------------------------+----------------------------->< '-DESCription--=--description-'
Parameters
- server_name (Required)
- Specifies the name of the server to be updated. This parameter is required.
- PAssword
- Specifies the password that is used to sign on to the target server for virtual volumes. This parameter is optional.
- SERVERPAssword
- Specifies the server password, which is used for enterprise configuration, command routing, and server-to-server event logging functions. The password must match the server password set by the SET SERVERPASSWORD command. This parameter is optional.
- HLAddress
- Specifies the IP address (in dotted decimal format) of the server. This parameter is optional.
- LLAddress
- Specifies the low-level address of the server. This address is usually the same as the address in the TCPPORT server option of the target server. When SSL=YES, the port must already be designated for SSL communications on the target server.
- COMMmethod
- Specifies the communication method that is used to connect to the server. This parameter is optional.
- URL
- Specifies the URL address that is used to access this server from the Administration Center. The parameter is optional.
- DELgraceperiod
- Specifies a number of days that an object remains on the target server after it was marked for deletion. You can specify a value 0 - 9999. The default is 5. This parameter is optional.
- NODEName
- Specifies a node name to be used by the server to connect to the target server. This parameter is optional.
- DESCription
- Specifies a description of the server. This parameter is optional. The description can be up to 255 characters. Enclose the description in quotation marks if it contains blank characters. To remove an existing description, specify a null string ('').
- FORCESync
- Specifies whether to reset the server verification key when the
source server next signs on to the target server. A valid verification
key enables a source server to put objects on the target server, manage
the grace deletion period value, and update the password, if the current
password is known and the verification key matches. The parameter
is optional. You can specify one of the following values:
- Yes
- Specifies that a new verification key will be sent to and accepted by the target server if a valid password is received.
- No
- Specifies that a new verification key will not be sent to the target server.
- VALIdateprotocol
- Specify a cyclic redundancy check to validate the data sent between
the storage agent and IBM Spectrum Protect™ server.
The parameter is optional. The default is NO. You can specify one
of the following values:
- No
- Specifies that data validation is not to be performed on any data sent between the storage agent and server.
- All
- Specifies that data validation is to be performed on all client file data, client file metadata, and the IBM Spectrum Protect server metadata that is sent between the storage agent and server. This mode affects performance as additional resources are required to calculate and compare CRC values between the storage agent and the server.
- ALLOWReplace
- Specifies whether a server definition that was defined by a managed
server can be replaced with a definition from the configuration manager.
This parameter is optional. You can specify one of the following values:
- Yes
- Specifies that a server definition can be replaced by a definition from the configuration manager.
- No
- Specifies that a server definition cannot be replaced by the definition from the configuration manager.
- SSL
- Specifies the communication mode of the server. You can specify
one of the following values:
- No
- Specifies that unencrypted communication with the specified server occurs over a TCP/IP session without SSL.
- Yes
- Specifies an SSL session for communication with the specified
server. The following conditions apply if you specify YES:
- Before starting the servers, self-signed certificates of the partner servers must be in the key database file (cert.kdb) of each of the servers.
- You can define multiple server names with different parameters for the same target server.
- SSL support is active if the server options file contains the SSLTCPPORT or SSLTCPADMINPORT option or if a server is defined with SSL=YES at startup.
- TRANSFERMethod
- Specifies the method that is used for server-to-server data transfer. This parameter is optional. You can specify one of the following values:
- Tcpip
- Specifies that TCP/IP is used to transfer data. This is the default.
- Fasp
- Specifies that Aspera® Fast Adaptive Secure Protocol (FASP®) technology is used to transfer data. Aspera
FASP technology can help you optimize data transfer in a wide area network (WAN). Restrictions:
- Before you enable Aspera FASP technology, determine whether the technology is appropriate for your system environment and install the appropriate licenses. For instructions, see Determining whether Aspera FASP technology can optimize data transfer in your system environment. If the licenses are missing or expired, data transfer operations fail.
- If WAN performance meets your business needs, do not enable Aspera FASP technology.
- If you specify TRANSFERMETHOD=FASP on the PROTECT STGPOOL or REPLICATE NODE command, that value overrides the TRANSFERMETHOD parameter on the DEFINE SERVER and UPDATE SERVER commands.
Example: Update a deletion grace period for a server
Update the definition of SERVER2 to specify that objects remain on the target server for 10 days after they were marked for deletion.update server server2 delgraceperiod=10
Example: Update the URL for a server
Update the definition of NEWSERVER to specify its URL address to be http://newserver:1580/.update server newserver url=http://newserver:1580/
Related commands
Command | Description |
---|---|
DEFINE DEVCLASS | Defines a device class. |
DEFINE SERVER | Defines a server for server-to-server communications. |
DELETE DEVCLASS | Deletes a device class. |
DELETE FILESPACE | Deletes data associated with client file spaces. If a file space is part of a collocation group and you remove the file space from a node, the file space is removed from the collocation group. |
DELETE SERVER | Deletes the definition of a server. |
QUERY NODE | Displays partial or complete information about one or more clients. |
QUERY SERVER | Displays information about servers. |
RECONCILE VOLUMES | Reconciles source server virtual volume definitions and target server archive objects. |
REGISTER NODE | Defines a client node to the server and sets options for that user. |
REMOVE NODE | Removes a client from the list of registered nodes for a specific policy domain. |
UPDATE DEVCLASS | Changes the attributes of a device class. |
UPDATE NODE | Changes the attributes that are associated with a client node. |