GET_LOGIN

Use the GET_LOGIN script function to retrieve login information or the password of a specific entry in a Login object. For more information, see Login (LOGIN).

Important!

You can only retrieve login entries for self-defined systems or applications, not operating systems.
Ensure that the Type parameter you define is also present in the UC_LOGIN_TYPES variable. For more information, see UC_LOGIN_TYPES - Defining Additional Platform and System Types for Login Objects.
Do not use percent (%) or caret (^) characters in passwords. GET_LOGIN retrieves the password in encrypted form. You can use the password with the Agent Job Messenger (CMD start parameter), where it is decrypted. For more information, see Agent Job Messenger.

Syntax

GET_LOGIN (Login object, Name, Type, Information)

Parameters

Parameter	Description	Format	Allowed Values
Login object	Name of the Login object	Script variable, AE name, or script literal	n.a.
Name	Agent name entry used in the Login object. You can use an asterisk (*) in single or double quotation marks instead of the name.	Script variable, AE name, or script literal	n.a.
Type	Type entry that defines the agent type	Script variable, AE name, or script literal	n.a.
Information	The information to retrieve	AE name	LOGIN_INFO — Retrieves login information such as user and domain PASSWORD — Retrieves the password

Return Codes

Return Value	Condition
20476	The specified object does not exist or is not of login type
20482	The specified name could not be found in the Login object
20493	Invalid specification of the information to retrieve

Examples

The following example retrieves the login information and password for the SVN entry from the Login object, then uses them in a Job Messenger command that defines the login credentials.

:SET &LOGIN# = GET_ATT(LOGIN)

:SET &LI# = GET_LOGIN(&LOGIN#,SVN,SVN,LOGIN_INFO)

: SET &PW# = GET_LOGIN(&LOGIN#,SVN,SVN,PASSWORD)

&UC_JOBMD CMD="&SVN_CMD# checkout ""&SVN_URI#"" ""&SVN_DIR#"" --username &LI# --password &PW#"