samctrl

Name

samctrl - Sets the System Automation for Multiplatforms control parameters.

Synopsis

samctrl [-h] -m [-f] [-T] [-V] [new_activeversion]

samctrl [-h] [-e PublisherName|-d PublisherName] [-M T|F] [-u a | d | r] [-t Timeout] [-l Trace_level][-r Retry_count] [-o ResourceRestartTimeOut] [-T] [-V] [Node [Node [...]]]

Description

The samctrl command sets the default control parameter values for System Automation for Multiplatforms. This command, when used, must change at least one control parameter for System Automation for Multiplatforms.

Options

-e PublisherName

Enables the named publisher. To enable all publishers, use -e P.

-d PublisherName

Disables the named publisher. To disable all publishers, use -d P. The default value is that all publishers are disabled.

-f

Force Migration. It requires the -m option. A force option (-mf) can be specified whether user insists to upgrade the code version when the joined System Automation for Multiplatforms daemon count is less than the total defined node count. The installed version number information of the down daemon is lower than the rest of the up daemons.

-h

Writes the command's usage statement to standard output.

-m

Migration. This option is used to trigger a System Automation for Multiplatforms code version migration complete action.

-M T|F

T (True): Manual mode. Deactivates System Automation for Multiplatforms on the cluster. After deactivation, resources are no longer automated and must be started and stopped manually. State changes of resource groups are not reflected in the System Automation Application Manager operations console. RMC commands must be used to retrieve the current states of the cluster resources.
Use this option in test environments only. It is useful in situations when the execution of a start or stop command must be avoided at all costs.
F (False): Automation mode (default). Reactivates System Automation for Multiplatforms on the cluster.

-u a | d | r

Specifies that one or more nodes are to be added to, removed from, or replaced on the list of excluded nodes.

a: Adds one or more specified nodes to the list of excluded nodes for control operations.
d: Deletes one or more specified nodes from the list of excluded nodes for control operations.
r: Replaces one or more specified nodes with the list of excluded nodes for control operations.

-r Retry_count

Specifies the default number of retries a control operation can perform before the operation is declared as failed.

-o ResourceRestartTimeout

Resource Restart Timeout value. Specifies the default timeout value (in seconds) before a failed resource is restarted. System Automation for Multiplatforms waits for the specified time before it restarts the resource on another node.

-t Timeout

Specifies the default timeout value (in seconds) of a control operation. A control operation is declared stalled or failed if the operation is not successfully completed within the specified time interval.

-l Trace_level

Sets the trace level to control the degree and amount of tracing. The maximum value of 255 results in detailed tracing, while the value 0 suppresses writing various classes of trace entries. The default level is 31. Change this option only if advised by IBM® support.

-T

Writes the command's trace messages to standard error. For your software-service organization's use only.

-V

Writes the command's verbose messages to standard output.

Parameters

Node: Specifies the name of one or more nodes that is added, removed, or replaced on the list of excluded nodes for control operations. The -u option and its parameter determines the action that is required to update the list of excluded nodes.
new_activeversion: Specifies the new active version value for System Automation for Multiplatforms. It requires the -m option.

Exit Status

0: The command ran successfully.
1: Error occurred with RMC.
2: Error occurred with CLI script.
3: Incorrect flag on command line.
4: Incorrect parameter on command line.
5: Error occurred with RMC that was based on faulty command line input.
6: Resource specified was not found.
7: Resource exists.

Security

This command requires root authority, or a user ID with appropriate permissions. For more information, see Setting up non-root user Ids for the command line interface.

Examples

Set System Automation for Multiplatforms to be in automated mode, with retries at 4, resource restart timeout as 5 seconds.
```
samctrl -M F -r 4 -o 5
```
Exclude some nodes from System Automation for Multiplatforms control:
```
samctrl -u a narten jarden varten
```
Migrate to the latest version, enter:
```
samctrl -m 
```
To force a migration to the latest version, enter:
```
samctrl -m  -f 
```
To enable the Tivoli Enterprise Console® publisher function, enter:
```
samctrl -e TEC
```

Files

/usr/sbin/rsct/bin/samctrl: Location of the samctrl command.