Ansible Automation Reference

This is a reference for the Ansible Automation integration.

Integration name

Name of the Ansible Automation integration instance.

Type

String

Required

Yes

Default

Ansible1

Ansible instance name

Name of the Ansible instance.

Type

String

Required

Yes

Default

Ansible1

Ansible instance API URL

URL of your Ansible instance API.

Type

String

Required

Yes

Default

http://<ansible server>:8052/api/v2/

Ansible instance user name for API requests

Ansible username for API requests.

Type

String

Required

Yes

Default

N/A

Ansible instance user password

Ansible password for API requests

Type

String

Required

Yes

Default

N/A

Wait for automation request response

Whether to wait for a response for automation requests.

Type

Boolean

Required

Yes

Default

No

Request timeout in seconds

Length of time (in seconds) to wait for a response from an automation request before returning a timeout.

Type

Integer

Required

If Wait For Automation Request Response is enabled.

Default

20

Lookup cache timeout in seconds

Length of time (in seconds) that a cached lookup is valid before it becomes stale and the query reruns. Applies to Credential and Inventory lookups.

Type

Integer

Required

Yes

Default

3600

Ansible instance automation status failure strings/codes

Specifies (as a comma-separated list) the automation failure status codes to use for Ansible.

Type

List

Required

Yes

Default

failure,failed,incomplete,aborted,escalated

Post results/stdout to Situation Room

Whether to post automation results to the Situation Room.

Type

Boolean

Required

Yes

Default

Yes

Ansible automation results summary fields

Specifies (as a comma-separated list) the request response fields to populate the custom info summary. Applies to synchronous requests to Ansible.

Type

List

Required

Yes

Default

name,list

Ansible automation results URL field

Specifies the request response URL field to use to populate the custom info results link. Applies to synchronous requests to Ansible.

Type

String

Required

Yes

Default

url

Workflow job template name

Name of the Moogsoft Enterprise workflow job template. setAnsibleJob directly references this value.

Type

String

Required

Yes

Default

N/A

Ansible job template name

Name of the Ansible job template to use. See the Ansible documentation for more information.

Type

String

Required

Yes

Default

N/A

Ansible job template field

Name of the Ansible job template mapping rule.

Type

String

Required

Yes

Default

N/A

String value and/or event reference

The payload mapping rule. You can enter this as a string value and/or event reference. For example, "Demo Inventory", $(custom_info.serviceName). You can also use macros to convert values. See Configure Payload Mapping Rules and Macros Reference for more information.

Type

String

Required

Yes

Default

N/A

Proxy settings

Specifies connection details for a proxy server if you want to connect to the external system through a proxy.

Use proxy in request

Property description.

Type

Boolean

Required

Yes

Default

No

Proxy host

Property description.

Type

String

Required

If Use Proxy in Request is set to Yes.

Default

N/A

Proxy user

Property description.

Type

String

Required

If Use Proxy in Request is set to Yes.

Default

N/A

Proxy port

Property description.

Type

Integer

Required

If Use Proxy in Request is set to Yes.

Default

N/A

Proxy password

Property description.

Type

String

Required

If Use Proxy in Request is set to Yes.

Default

N/A