- This Ansible module shows information from Control-M Agent, such as configuration or a communication diagnostic report.
---
- name: test the win_controlm_agent_facts module
hosts: all
gather_facts: false
roles:
- win_controlm_agent_facts
tasks:
- name: Gather facts from Control-M Agent
win_controlm_agent_facts:
- name: Displays the Configuration
debug:
var: ansible_controlm_agent.config
- name: Displays the Configuration
debug:
var: ansible_controlm_agent.communication_diagnostic_report
Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.
| Fact | Returned | Description |
|---|---|---|
| ansible_controlm_agent complex |
always | Detailed information about the Control-M Agent installation. |
| communication_diagnostic_report dictionary |
success | Detailed information about Agent issues. |
| agent_state string |
success | Current state of the Windows agent. Sample: as Running or Stopped or Paused |
| agent_start_mode string |
success | Startup type of the Windows agent service. Sample: as Automatic or Manual |
| user_name string |
success | Account name under which the Windows agent service runs. Sample: LocalSystem |
| agent_status string |
success | Current status of the Windows service. Sample: as OK or Degraded or Error or Pred Fail |
| server_agent_connection_mode string |
success | Indicates whether the agent is connected to the server in persistent connection mode. Sample: as persistent or transient |
| server_agent_communication_protocol string |
success | Protocol type of the Server-Agent communication. Sample: as TCP or SSL |
| system_ping_to_server_platform boolean |
success | Ping connectivity to the primary server. |
| agent_ping_to_controlm_server boolean |
success | Indicates that CONTROL-M/Server is active on the Server platform that is connected to the Agent platform. |
| dns_translation_of_server boolean |
success | IP address of the primary server host. Sample: 192.168.1.1 |
| config dictionary |
success | Detailed information about stored the configuration. |
| agent_to_server_port integer |
success | Port number in the Control-M Agent computer where data is received from the Control-M Server computer. Sample: 7006 |
| allow_comm_init boolean |
success | Indicates whether the agent can open a connection to the server when working in persistent connection mode. |
| authorized_controlm_server_hosts string |
success | List of backup servers which can replace the primary server if it fails. |
| autoedit_inline boolean |
success | Indicates whether all variables will be set as environment variables in the script. |
| cjk_encoding string |
success | CJK encoding used by Control-M Agent to run jobs. Sample: UTF-8 |
| communication_trace boolean |
success | Indicates whether communication packets that Control-M Agent sends to and receives from Control-M Server are written to a file. |
| ctms_address_mode string |
success | Indicates if the IP address is used instead of the host name. |
| daily_log_file_enabled boolean |
success | Indicates if the ctmag_<year><month><day>.log file is generated. |
| days_to_retain_log_files integer |
success | Number of days to retain agent proclog files. Sample: 1 |
| default_printer string |
success | Default printer for job OUTPUT files. |
| diagnostic_level integer |
success | Debug level. Sample: 0 |
| echo_job_commands_into_sysout boolean |
success | Indicates whether to print commands in the OUTPUT of a job. |
| foreign_language_support string |
success | Indicates whether the system is configured for CJK languages or Latin1 languages. Sample: LATIN-1 |
| job_children_inside_job_object boolean |
success | Indicates whether procedures invoked by a job can be run outside the Job Object. |
| limit_log_file_size integer |
success | Maximum size (MB) of diagnostic log files for a process or a thread. Sample: 10 |
| limit_log_version integer |
success | Number of generations of diagnostic log information to keep for a process or a thread. Sample: 10 |
| listen_to_network_interface string |
success | Network interface the agent is listening on. Sample: *ANY |
| logical_agent_name string |
success | Logical name of the agent. |
| logon_as_user boolean |
success | Indicates whether the user account is used for the services to log on to. |
| logon_domain string |
success | Logon domain of the user account. |
| measure_usage_day integer |
success | Number of days to retain the files in the dailylog directory. Sample: 7 |
| persistent_connection boolean |
success | Indicates whether NS process creates a persistent connection with the agent and manages the session with this agent. |
| primary_controlm_server_host string |
success | Hostname of the computer where the current Control-M Server submits jobs to the Control-M Agent. |
| server_agent_protocol_version integer |
success | Server-Agent communication protocol version. Sample: 12 |
| run_user_logon_script boolean |
success | Indicates wether a user-defined logon script should be run by the Control-M Agent before running the standard user logon script. |
| server_to_agent_port integer |
success | Port number that receives data from the Control-M Agent computer. Sample: 7005 |
| smtp_port integer |
success | Port number on which the SMTP server communicates. Sample: 25 |
| smtp_reply_to_mail string |
success | E-mail address to which to send replies. |
| smtp_sender_friendly_name string |
success | Name or alias that appears on the e-mail sent. |
| smtp_sender_mail string |
success | E-mail address of the sender. Sample: control@m |
| smtp_server_relay_name string |
success | Name of the SMTP server. |
| ssl boolean |
success | Indicates whether SSL is used to encrypt the communication between Control-M Server and the Control-M Agent. |
| job_output_name string |
success | Prefix for the OUTPUT file name. Sample: JOBNAME |
| tcpip_timeout integer |
success | Communication job-tracking timeout in seconds. Sample: 60 |
| timeout_for_agent_utilities integer |
success | Maximum time (in seconds) the agent waits after sending a request to Control-M Server. Sample: 600 |
| tracker_event_port integer |
success | Number of the port for sending messages to the Tracker process when jobs end. Sample: 7035 |
| tracker_polling_interval integer |
success | Tracker event timeout in seconds. Sample: 60 |
| wrap_parameters_with_double_quotes integer |
success | Indicates how parameter values (%%PARMn....%%PARMx) are managed by Control-M Agent for Microsoft Windows. Sample: 4 |
| default_agent_name string |
success | Agent name. Sample: Default |
| cm_name string |
success | Version of the Control/M application. Sample: WIN |
| cm_type string |
success | Type of the Control/M plateforme. Sample: WIN2K |
| agent_version dictionary |
success | Dictionary/map that contains information about the current running version of the agent. |
| full string |
The full string of the version. Sample: 9.0.20.100 |
|
| major integer |
The major component of the version number. Sample: 9 |
|
| minor integer |
The minor component of the version number. Sample: 0 |
|
| build integer |
The build component of the version number. Sample: 20 |
|
| revision integer |
The revision component of the version number. A higher revision number might be used in a build that fixes a security hole in a previously released agent. Sample: 100 |
|
| fd_number string |
success | Unique identifier of the agent. Sample: DRKAI.9.0.20.000 |
| fix_number string |
success | Unique identifier of the fix pack. Sample: DRKAI.9.0.20.000 |
| agent_directory string |
success | Installation folder of the agent. Sample: C:\Program Files\Control-M Agent\Default |
- Stéphane Bilqué (@sbilque) Informatique CDC
This project is licensed under the Apache 2.0 License.
See LICENSE to see the full text.