Automation Engine Script Guide > Ordered by Function > Read or Modify Objects > GET_LOGIN

GET_LOGIN

Script Function: Reads information from Login objects.

Syntax

GET_LOGIN(Login object, Name, Type, Information)

Syntax

Description/Format

Login objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task

The name of a Login object.
Format: script variable, AE name or scriptA particular Automation Engine object type. literal

Name

The name of the entry in the Login object.
Format: script variableA placeholder for a value within a script., AE name or script literal

Type

The type of the loginAn Automation Engine object type that stores account credentials used by agents on target systems. entry.
Format: script variable, AE name or script literal

Information

The information that should be read.
Format: AE name

Allowed values:
LOGIN_INFO - Reads the login information (userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management., domain).
PASSWORD - Password

Return Code

The relevant information.

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 that should be read.

Comments

This script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… supplies the login information or the passwordA secret combination of characters for a Automation Engine user. of a certain entry in the specified Login object. The parameters Name and Type decide upon the entry.

You can only read the login entries of backend systems! Make sure that the specified Type is also available in the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. UC_LOGIN_TYPES.

The password is returned in encrypted form. You can use the password with the Job Messenger (start parameter CMD) where it will be decrypted.

You can use "*" for the Name (use single or double quotation marks). Note that "*" in this case is an own entry in the Login object and not a filter.

Examples

The following example reads the login information and the password of the backend-system entry SVN from the Login object and runs a command run via the Job Messenger afterwards that specifies the login data.

: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#"

 

See also:

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH