Creating automation policies

After you enabled and configured the Universal Automation Adapter (UAA), you need to define a new UAA policy for each configured UAA domain.

1. Log in to the IBM Z Automation Web Console and open the Manage Automation Policies dashboard.
2. In widget Domains, select a UAA domain for which you want to define policies.
3. In widget Policies, click Actions > New....
   The Edit Automation Policy dashboard is displayed.
4. In widget Policy Information, specify the required (marked with *) policy information.

   Policy name

   Name of the policy.

   Note: The policy name must be unique to the other policies in the domain.

   Policy file name

   File name of the policy.

   Note: The policy file name must be unique to the other policy files in the domain.

   Policy token

   Token that is used for versioning of policy files.

   Automation domain

   Domain name of the policy.

   Policy author

   Author of the policy.

   Policy description

   Description for the policy.

   Click Save to save all the settings.

5. In widget Remote Applications, click Actions > New... to add a new resource. You need to define remote applications in the policy, and specify the host name, user ID, and start, stop, and monitor commands for the remote application.
   In the dialogue Edit Remote Application, specify the following parameters:

   Note: You must specify a value for the field that is marked with *.

   General

   Name

   The name of the resource.

   Note: The resource name must be unique to the other resources in the domain.

   Owner

   The owner of the resource. The owner information is displayed on the SA dashboards in the tooltip of a resource and should enable a user to contact the resource owner if necessary. Useful information includes the owner's name and telephone number.

   Info Link

   The URL that points to additional information about the resource.

   Description

   Description for the resource. The description is optional with a maximum length of 1024 characters.

   Remote System Access

   Host name

   The host name of the remote system.

   Note: If you are using Container to run IBM Z Automation Web Console and the remote resource runs on the same host system as the IBM Z Automation Web Console Container, you must configure a different host name in the IBM Z Automation Web Console Container. For more information, see Network and ports information.

   User ID

   The user name under which the Monitor Command, Start Command, and Stop Command are run. The commands run with the authority and environment of the specified user. A check is made on each node to ensure that the user name exists whenever the policy is activated.

   Note: The value must match a user ID that you specified under tab User Credentials of Universal Automation Adapter in web configuration tool.

   SSH Port

   Specifies the network port that is used for the target system access. The default port value is 22.

   Start, Stop, Monitor Attributes

   Start Command

   Fully qualified name of the script that is used to start the resource. For more information about the start and stop commands, see Using start and stop commands.

   Start Command Timeout

   Number of seconds that the Start Command can run before starting is canceled. It also specifies the time after which the resource is expected to be available. The default value is 10 seconds.

   Stop Command

   Fully qualified name of the script that is used to stop the resource.

   Stop Command Timeout

   Number of seconds that the Stop Command can run before stopping is canceled. The default value is 10 seconds.

   Monitor Command

   Fully qualified name of the script that is used to monitor the resource through polling. For more information about the monitor command, see Using the monitor command.

   Monitor Command Timeout

   Number of seconds the Monitor Command can run before the monitor command is canceled and the operational state of the resource is set to Unknown=0. The default value is 10 seconds.

   Monitor Command Period

   Waiting period (in seconds) between invocations of the Monitor Command. The period begins when the preceding invocation completes, which is why its value can be greater than the Monitor Command Timeout value. The default value is 10 seconds.

   Monitor Command Return Codes

   Specifies how the monitor command return code is interpreted. Possible values are UNIX and SA MP. The default value is UNIX.

   • If you use UNIX style return codes, a return code 0 means Observed State Available and everything else is interpreted as Unavailable.
   • If you use SA MP style return codes, you have a granular control on how the return code is interpreted because the return codes 0 - 6 correspond to different Observed States. For example, '1' means Available, '2' means Unavailable, and so on.