Login operation for the BMC Network Automation adapter

The Login operation enables you to establish a session with the BMC Network Automation application using the specified user name and password. The following table describes the elements for the <items> XML element and adapter request for the Login operation.

Elements for the <items> XML element and adapter request for the Login operation

Element	Definition	Required
`<entity>`	Specifies the type of operation: `authentication`	Yes
`<operation-name>`	Specifies the name of operation: `do-login`	Yes
`<user-name>`	Specifies the user name for logging on to the BMC Network Automation application The user can be a system administrator, manager, planner, or viewer.	Yes
`<password>`	Specifies the password corresponding to the specified <user-name>	Yes

The following figure shows a sample <items> XML element for the Login operation.

<items> XML element for the Login operation

<items>
  <item>
    <parameters>
      <user-name></user-name>
      <password></password>
    </parameters>
  </item>
</items>

The following figure shows a sample adapter request for the Login operation.

Sample adapter request for the Login operation

<bmc-configuration-automation-networks-request>
<entity>authentication</entity>
<request>
  <operation-name>do-login</operation-name>
  <parameters>
    <user-name>sysadmin</user-name>
    <password>bmc123</password>
  </parameters>
</request>
</bmc-configuration-automation-networks-request>

The following figure illustrates the adapter response for the sample Login operation.

Adapter response for the Login operation

<bmc-configuration-automation-networks-response>
  <metadata>
    <status>success</status>
  </metadata>
  <parameters>
    <output>3892526615668584829</output>
  </parameters>
</bmc-configuration-automation-networks-response>

Login operation for the BMC Network Automation adapter

Comments