ADMLOGON

8.7

The ADMLOGON instruction connects the program to a Sunbelt administrative host. The instruction uses the following format:

Where:

label

Optional. A Program Execution Label.

admin

Required. A previously defined ADMIN variable.

ip

Required. The IP address of the server using an IPV4 socket when using syntax format (1).

ipv6

Required. The IP address of the server using an IPV6 socket when using syntax format (2).

port

Required. An administrative port number of the server.

public

Optional. The public encryption key.

logon

Optional. The logon encryption key.

Flags Affected: ZERO

Note the following:

1. A failure to connect to the administrative task will result in an object (O) error that may be trapped.

2. The optional public and logon keys override the ADMIN_PUBLIC and ADMIN_LOGON configuration parameters.

3. The {ipaddr} can be set to "local" to access the server currently running the program (Application server or Automation server) without going through the logon port. Any ADMIN_KEYFILE used by the local application server will still be checked for security purposes.

4. The ADMIN_SUPPORT server configuration parameter must be set to ON before the administrative functions of the server are enabled.

5. The ZERO flag is set to indicate that the command was syntactically correct. It does not indicate the success or failure of the command.

6. It is recommended that an ADMLOGOFF instruction be executed when the ADMIN functions in a program are complete.

7. When the syntax format (2) is being used (10.7), the {ipv6} parameter data must be enclosed in '[]' brackets and formatted for an IPV6 address as follows:

 

ADMLOGON Admin, "[::1]",2100

or

AMLOGON Admin, "[localipv6-test.home]",2100.

See Also: System Interface Instructions