Skip to main content

Operation configuration

In order for agtxml to perform an agent operation, you must configure the corresponding operation KVGroup in your script under the "operations" KVGroup. You write these sub KVGroups to provide interaction details between Bravura Security Fabric and the target.

Additionally, the login and logout operations are executed (if present in the script). The login is executed proceeding an operation call. The logout is execute succeeding an operation call.

An operation KVGroup includes the following key-values and sub KVGroups:

  • active boolean; if true, the operation is active and supported

  • contentType the mime type sent on the HTTP request

  • method the method specified for the HTTP request (POST is currently the only supported method)

  • trueval The value that represents true for "is" operations

  • successval The expected value to match with $issuccess in the response

  • request The sub KVGroup that maps to the XML request to the web Service

  • response The sub KVGroup that maps the XML response from the web Service

The "request" KVGroup describes the header and body of the XML message. Local variables or built-in variables can be used to substitute text with a session key or credentials, respectively.

The following built-in variables are available for replacement:

  • $adminid Administrator ID

  • $adminpw Administrator password

  • $sysid System account ID

  • $syspw System account password

  • $userid Profile ID

  • $fullname Full name of the profile

  • $acctid Account ID

  • $shortid Short ID of the account

  • $newpw New password of the user

  • $oldpw Old/Current password of the user

  • $moduleuid Account ID of the template account

  • $groupid Group ID of the managed group

  • $groupname Group description of the managed group

  • $session Session ID

The "response" KVGroup describes the parsing of the response from the XML Web Service.