Linux
Ansible Linux Pack.#
This Integration is part of theSupported versions
Supported Cortex XSOAR versions: 6.0.0 and later.
This integration enables the management of Linux hosts directly from XSOAR using Ansible modules. The Ansible engine is self-contained and pre-configured as part of this pack onto your XSOAR server, all you need to do is provide credentials you are ready to use the feature rich commands. This integration functions without any agents or additional software installed on the hosts by utilising SSH combined with Python.
To use this integration, configure an instance of this integration. This will associate a credential to be used to access hosts when commands are run. The commands from this integration will take the Linux host address(es) as an input, and use the saved credential associated to the instance to execute. Create separate instances if multiple credentials are required.
#
RequirementsThe Linux host(s) being managed requires Python >= 2.6. Different commands will use different underlying Ansible modules, and may have their own unique package requirements. Refer to the individual command documentation for further information.
#
Network RequirementsBy default, TCP port 22 will be used to initiate a SSH connection to the Linux host.
The connection will be initiated from the XSOAR engine/server specified in the instance settings.
#
CredentialsThis integration supports a number of methods of authenticating with the Linux Host:
- Username & Password entered into the integration
- Username & Password credential from the XSOAR credential manager
- Username and SSH Key from the XSOAR credential manager
#
PermissionsWhilst un-privileged Linux user privileges can be used, a SuperUser account is recommended as most commands will require elevated permissions to execute.
#
Privilege EscalationAnsible can use existing privilege escalation systems to allow a user to execute tasks as another. Different from the user that logged into the machine (remote user). This is done using existing privilege escalation tools, which you probably already use or have configured, like sudo, su, or doas. Unless you are remoting into the system as root (uid 0) you will need to escalate your privileges to a super user. Use the Integration parameters Escalate Privileges
, Privilege Escalation Method
, Privilege Escalation User
, Privileges Escalation Password
to configure this.
#
ConcurrencyThis integration supports execution of commands against multiple hosts concurrently. The host
parameter accepts a list of addresses, and will run the command in parallel as per the Concurrency Factor value.
#
Further informationThis integration is powered by Ansible 2.9. Further information can be found on that the following locations:
#
Configure Ansible Linux in CortexParameter | Description | Required |
---|---|---|
Username | The credentials to associate with the instance. SSH keys can be configured using the credential manager. | True |
Password | True | |
Default SSH Port | The default port to use if one is not specified in the commands `host` argument. | True |
Concurrency Factor | If multiple hosts are specified in a command, how many hosts should be interacted with concurrently. | True |
Escalate Privileges | Ansible allows you to ‘become’ another user, different from the user that logged into the machine (remote user). | True |
Privilege Escalation Method | Which privilege escalation method should be used. | True |
Privilege Escalation User | Set the user you become through privilege escalation | False |
Privilege Escalation Password | Set the privilege escalation password. | False |
#
TestingThis integration does not support testing from the integration management screen. Instead it is recommended to use the !linux-gather-facts
command providing an example host
as the command argument. This command will connect to the specified host with the configured credentials in the integration, and if successful output general information about the host.
#
IdempotenceThe action commands in this integration are idempotent. This means that the result of performing it once is exactly the same as the result of performing it repeatedly without any intervening actions.
#
State ArguementSome of the commands in this integration take a state argument. These define the desired end state of the object being managed. As a result these commands are able to perform multiple management operations depending on the desired state value. Common state values are: | State | Result | | --- | --- | | present | Object should exist. If not present, the object will be created with the provided parameters. If present but not with correct parameters, it will be modified to met provided parameters. | | running | Object should be running not stopped. | | stopped | Object should be stopped not running. | | restarted | Object will be restarted. | | absent | Object should not exist. If it it exists it will be deleted. |
#
Complex Command InputsSome commands may require structured input arguments such as lists
or dictionary
, these can be provided in standard JSON notation wrapped in double curly braces. For example a argument called dns_servers
that accepts a list of server IPs 8.8.8.8 and 8.8.4.4 would be entered as dns_servers="{{ ['8.8.8.8', '8.8.4.4'] }}"
.
Other more advanced data manipulation tools such as Ansible/Jinja2 filters can also be used in-line. For example to get a random number between 0 and 60 you can use {{ 60 | random }}
.
#
CommandsYou can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
#
linux-alternativesManages alternative programs for common commands Further documentation available at https://docs.ansible.com/ansible/2.9/modules/alternatives_module.html
#
Base Commandlinux-alternatives
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | The generic name of the link. | Required |
path | The path to the real executable that the link should point to. | Required |
link | The path to the symbolic link that should point to the real executable. This option is always required on RHEL-based distributions. On Debian-based distributions this option is required when the alternative name is unknown to the system. | Optional |
priority | The priority of the alternative. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-alternatives host="123.123.123.123" name="java" path="/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.292.b10-0.el8_3.x86_64/jre/bin/java"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
linux-atSchedule the execution of a command or script file via the at command Further documentation available at https://docs.ansible.com/ansible/2.9/modules/at_module.html
#
Base Commandlinux-at
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
command | A command to be executed in the future. | Optional |
script_file | An existing script file to be executed in the future. | Optional |
count | The count of units in the future to execute the command or script file. | Required |
units | The type of units in the future to execute the command or script file. Possible values are: minutes, hours, days, weeks. | Required |
state | The state dictates if the command or script file should be evaluated as present(added) or absent(deleted). Possible values are: absent, present. Default is present. | Optional |
unique | If a matching job is present a new job will not be added. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-at host="123.123.123.123" command="ls -d / >/dev/null" count="20" units="minutes"
#
Context Example#
Human Readable Output#
123.123.123.123 - CHANGED
- changed: True
- count: 20
- script_file: /tmp/at248vavr9
- state: present
- units: minutes
#
linux-authorized-keyAdds or removes an SSH authorized key Further documentation available at https://docs.ansible.com/ansible/2.9/modules/authorized_key_module.html
#
Base Commandlinux-authorized-key
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
user | The username on the remote host whose authorized_keys file will be modified. | Required |
key | The SSH public key(s), as a string or (since Ansible 1.9) url (https://github.com/username.keys). | Required |
path | Alternate path to the authorized_keys file. When unset, this value defaults to ~/.ssh/authorized_keys . | Optional |
manage_dir | Whether this module should manage the directory of the authorized key file. If set to yes , the module will create the directory, as well as set the owner and permissions of an existing directory.Be sure to set manage_dir=no if you are using an alternate directory for authorized_keys, as set with path , since you could lock yourself out of SSH access.See the example below. Possible values are: Yes, No. Default is Yes. | Optional |
state | Whether the given key (with the given key_options) should or should not be in the file. Possible values are: absent, present. Default is present. | Optional |
key_options | A string of ssh key options to be prepended to the key in the authorized_keys file. | Optional |
exclusive | Whether to remove all other non-specified keys from the authorizedkeys file. Multiple keys can be specified in a single key string value by separating them by newlines.This option is not loop aware, so if you use `with , it will be exclusive per iteration of the loop.<br/>If you want multiple keys in the file you need to pass them all to key` in a single batch as mentioned above. Possible values are: Yes, No. Default is No. | Optional |
validate_certs | This only applies if using a https url as the source of the keys. If set to no , the SSL certificates will not be validated.This should only set to no used on personally controlled sites using self-signed certificates as it avoids verifying the source site.Prior to 2.1 the code worked as if this was set to yes . Possible values are: Yes, No. Default is Yes. | Optional |
comment | Change the comment on the public key. Rewriting the comment is useful in cases such as fetching it from GitHub or GitLab. If no comment is specified, the existing comment will be kept. | Optional |
follow | Follow path symlink instead of replacing it. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.AuthorizedKey.exclusive | boolean | If the key has been forced to be exclusive or not. |
Linux.AuthorizedKey.key | string | The key that the module was running against. |
Linux.AuthorizedKey.key_option | string | Key options related to the key. |
Linux.AuthorizedKey.keyfile | string | Path for authorized key file. |
Linux.AuthorizedKey.manage_dir | boolean | Whether this module managed the directory of the authorized key file. |
Linux.AuthorizedKey.path | string | Alternate path to the authorized_keys file |
Linux.AuthorizedKey.state | string | Whether the given key (with the given key_options) should or should not be in the file |
Linux.AuthorizedKey.unique | boolean | Whether the key is unique |
Linux.AuthorizedKey.user | string | The username on the remote host whose authorized_keys file will be modified |
Linux.AuthorizedKey.validate_certs | boolean | This only applies if using a https url as the source of the keys. If set to `no`, the SSL certificates will not be validated. |
#
Command Example!linux-authorized-key host="123.123.123.123" user="charlie" state="present" key="ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC/...REDACTED..uH04Ef2RICcn1iCtsqQcMZfoqFftRcGi2MyYFyRQrFs= charlie@web01"
#
Context Example#
Human Readable Output#
123.123.123.123 - CHANGED
- changed: True
- comment: None
- exclusive: False
- follow: False
- key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQC/...REDACTED..uH04Ef2RICcn1iCtsqQcMZfoqFftRcGi2MyYFyRQrFs= charlie@web01
- key_options: None
- keyfile: /home/charlie/.ssh/authorized_keys
- manage_dir: True
- path: None
- state: present
- user: charlie
- validate_certs: True
#
linux-capabilitiesManage Linux capabilities Further documentation available at https://docs.ansible.com/ansible/2.9/modules/capabilities_module.html
#
Base Commandlinux-capabilities
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
path | Specifies the path to the file to be managed. | Required |
capability | Desired capability to set (with operator and flags, if state is present ) or remove (if state is absent ). | Required |
state | Whether the entry should be present or absent in the file's capabilities. Possible values are: absent, present. Default is present. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-cronManage cron.d and crontab entries Further documentation available at https://docs.ansible.com/ansible/2.9/modules/cron_module.html
#
Base Commandlinux-cron
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Description of a crontab entry or, if env is set, the name of environment variable. Required if state=absent .Note that if name is not set and state=present , then a new crontab entry will always be created, regardless of existing ones.This parameter will always be required in future releases. | Optional |
user | The specific user whose crontab should be modified. When unset, this parameter defaults to using root . | Optional |
job | The command to execute or, if env is set, the value of environment variable. The command should not contain line breaks. Required if state=present . | Optional |
state | Whether to ensure the job or environment variable is present or absent. Possible values are: absent, present. Default is present. | Optional |
cron_file | If specified, uses this file instead of an individual user's crontab. If this is a relative path, it is interpreted with respect to /etc/cron.d .If it is absolute, it will typically be /etc/crontab .Many linux distros expect (and some require) the filename portion to consist solely of upper- and lower-case letters, digits, underscores, and hyphens. To use the cron_file parameter you must specify the user as well. | Optional |
backup | If set, create a backup of the crontab before it is modified. The location of the backup is returned in the backup_file variable by this module. Possible values are: Yes, No. Default is No. | Optional |
minute | Minute when the job should run ( 0-59, , /2, etc ). Default is *. | Optional |
hour | Hour when the job should run ( 0-23, , /2, etc ). Default is *. | Optional |
day | Day of the month the job should run ( 1-31, , /2, etc ). Default is *. | Optional |
month | Month of the year the job should run ( 1-12, , /2, etc ). Default is *. | Optional |
weekday | Day of the week that the job should run ( 0-6 for Sunday-Saturday, , etc ). Default is . | Optional |
reboot | If the job should be run at reboot. This option is deprecated. Users should use special_time. Possible values are: Yes, No. Default is No. | Optional |
special_time | Special time specification nickname. Possible values are: annually, daily, hourly, monthly, reboot, weekly, yearly. | Optional |
disabled | If the job should be disabled (commented out) in the crontab. Only has effect if state=present . Possible values are: Yes, No. Default is No. | Optional |
env | If set, manages a crontab's environment variable. New variables are added on top of crontab. name and value parameters are the name and the value of environment variable. Possible values are: Yes, No. Default is No. | Optional |
insertafter | Used with state=present and env .If specified, the environment variable will be inserted after the declaration of specified environment variable. | Optional |
insertbefore | Used with state=present and env .If specified, the environment variable will be inserted before the declaration of specified environment variable. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-cron host="123.123.123.123" name="check dirs" minute="0" hour="5,2" job="ls -alh > /dev/null"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
#
linux-cronvarManage variables in crontabs Further documentation available at https://docs.ansible.com/ansible/2.9/modules/cronvar_module.html
#
Base Commandlinux-cronvar
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of the crontab variable. | Required |
value | The value to set this variable to. Required if state=present . | Optional |
insertafter | If specified, the variable will be inserted after the variable specified. Used with state=present . | Optional |
insertbefore | Used with state=present . If specified, the variable will be inserted just before the variable specified. | Optional |
state | Whether to ensure that the variable is present or absent. Possible values are: absent, present. Default is present. | Optional |
user | The specific user whose crontab should be modified. This parameter defaults to root when unset. | Optional |
cron_file | If specified, uses this file instead of an individual user's crontab. Without a leading / , this is assumed to be in /etc/cron.d .With a leading / , this is taken as absolute. | Optional |
backup | If set, create a backup of the crontab before it is modified. The location of the backup is returned in the backup variable by this module. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-cronvar host="123.123.123.123" name="EMAIL" value="doug@ansibmod.con.com"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
Vars
- 0: EMAIL
#
linux-dconfModify and read dconf database Further documentation available at https://docs.ansible.com/ansible/2.9/modules/dconf_module.html
#
Base Commandlinux-dconf
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
key | A dconf key to modify or read from the dconf database. | Required |
value | Value to set for the specified dconf key. Value should be specified in GVariant format. Due to complexity of this format, it is best to have a look at existing values in the dconf database. Required for state=present . | Optional |
state | The action to take upon the key/value. Possible values are: read, present, absent. Default is present. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Dconf.value | string | value associated with the requested key |
#
Command Example!linux-dconf host="123.123.123.123" key="/org/gnome/desktop/input-sources/sources" value="[('xkb', 'us'), ('xkb', 'se')]" state="present"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
linux-debconfConfigure a .deb package Further documentation available at https://docs.ansible.com/ansible/2.9/modules/debconf_module.html
#
Base Commandlinux-debconf
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of package to configure. | Required |
question | A debconf configuration setting. | Optional |
vtype | The type of the value supplied. It is highly recommended to add no_log=True to task while specifying vtype=password .seen was added in Ansible 2.2. Possible values are: boolean, error, multiselect, note, password, seen, select, string, text, title. | Optional |
value | Value to set the configuration to. | Optional |
unseen | Do not set 'seen' flag when pre-seeding. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-filesystemMakes a filesystem Further documentation available at https://docs.ansible.com/ansible/2.9/modules/filesystem_module.html
#
Base Commandlinux-filesystem
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
fstype | Filesystem type to be created. reiserfs support was added in 2.2. lvm support was added in 2.5. since 2.5, dev can be an image file.vfat support was added in 2.5 ocfs2 support was added in 2.6 f2fs support was added in 2.7 swap support was added in 2.8. Possible values are: btrfs, ext2, ext3, ext4, ext4dev, f2fs, lvm, ocfs2, reiserfs, xfs, vfat, swap. | Required |
dev | Target path to device or image file. | Required |
force | If yes , allows to create new filesystem on devices that already has filesystem. Default is no. | Optional |
resizefs | If yes , if the block device and filesystem size differ, grow the filesystem into the space.Supported for ext2 , ext3 , ext4 , ext4dev , f2fs , lvm , xfs , vfat , swap filesystems.XFS Will only grow if mounted. vFAT will likely fail if fatresize < 1.04. Default is no. | Optional |
opts | List of options to be passed to mkfs command. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-filesystem host="123.123.123.123" fstype="ext2" dev="/dev/sdb1"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
linux-firewalldManage arbitrary ports/services with firewalld Further documentation available at https://docs.ansible.com/ansible/2.9/modules/firewalld_module.html
#
Base Commandlinux-firewalld
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
service | Name of a service to add/remove to/from firewalld. The service must be listed in output of firewall-cmd --get-services. | Optional |
port | Name of a port or port range to add/remove to/from firewalld. Must be in the form PORT/PROTOCOL or PORT-PORT/PROTOCOL for port ranges. | Optional |
rich_rule | Rich rule to add/remove to/from firewalld. | Optional |
source | The source/network you would like to add/remove to/from firewalld. | Optional |
interface | The interface you would like to add/remove to/from a zone in firewalld. | Optional |
icmp_block | The ICMP block you would like to add/remove to/from a zone in firewalld. | Optional |
icmp_block_inversion | Enable/Disable inversion of ICMP blocks for a zone in firewalld. | Optional |
zone | The firewalld zone to add/remove to/from. Note that the default zone can be configured per system but public is default from upstream.Available choices can be extended based on per-system configs, listed here are "out of the box" defaults. Possible values include block , dmz , drop , external , home , internal , public , trusted , work . | Optional |
permanent | Should this configuration be in the running firewalld configuration or persist across reboots. As of Ansible 2.3, permanent operations can operate on firewalld configs when it is not running (requires firewalld >= 3.0.9). Note that if this is no , immediate is assumed yes . | Optional |
immediate | Should this configuration be applied immediately, if set as permanent. Possible values are: Yes, No. Default is No. | Optional |
state | Enable or disable a setting. For ports: Should this port accept (enabled) or reject (disabled) connections. The states present and absent can only be used in zone level operations (i.e. when no other parameters but zone and state are set). Possible values are: absent, disabled, enabled, present. | Required |
timeout | The amount of time the rule should be in effect for when non-permanent. Default is 0. | Optional |
masquerade | The masquerade setting you would like to enable/disable to/from zones within firewalld. | Optional |
offline | Whether to run this module even when firewalld is offline. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-firewalld host="123.123.123.123" service="https" permanent="True" state="enabled"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- msg: Permanent operation
#
linux-gather-factsGathers facts about remote hosts Further documentation available at https://docs.ansible.com/ansible/2.9/modules/gather_facts_module.html
#
Base Commandlinux-gather-facts
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
parallel | A toggle that controls if the fact modules are executed in parallel or serially and in order. This can guarantee the merge order of module facts at the expense of performance. By default it will be true if more than one fact module is used. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-gather-facts host="123.123.123.123"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- architecture: x86_64
- bios_date: 04/05/2016
- bios_vendor: Phoenix Technologies LTD
- bios_version: 6.00
- board_asset_tag: NA
- board_name: 440BX Desktop Reference Platform
- board_serial: None
- board_vendor: Intel Corporation
- board_version: None
- chassis_asset_tag: No Asset Tag
- chassis_serial: None
- chassis_vendor: No Enclosure
- chassis_version: N/A
- distribution: CentOS
- distribution_file_parsed: True
- distribution_file_path: /etc/redhat-release
- distribution_file_variety: RedHat
- distribution_major_version: 8
- distribution_release: Core
- distribution_version: 8.2
- domain: lan
- effective_group_id: 0
- effective_user_id: 0
- fips: False
- form_factor: Other
- fqdn: web01.lan
- hostname: web01
- hostnqn:
- is_chroot: False
- iscsi_iqn:
- kernel: 4.18.0-193.28.1.el8_2.x86_64
- kernel_version: #1 SMP Thu Oct 22 00:20:22 UTC 2020
- machine: x86_64
- machine_id: c919c21e349f4cbe8cf16333aae4701d
- memfree_mb: 1412
- memtotal_mb: 1986
- nodename: web01
- os_family: RedHat
- pkg_mgr: dnf
- processor_cores: 1
- processor_count: 1
- processor_nproc: 1
- processor_threads_per_core: 1
- processor_vcpus: 1
- product_name: VMware Virtual Platform
- product_serial: VMware-56 4d d7 77 f1 ba 7c ad-c0 15 39 73 2f bb 37 cb
- product_uuid: 77d74d56-baf1-ad7c-c015-39732fbb37cb
- product_version: None
- python_version: 3.6.8
- real_group_id: 0
- real_user_id: 0
- selinux_python_present: True
- service_mgr: systemd
- ssh_host_key_ecdsa_public: AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBCjaVzeB+MYtwIxrdDDkNbnVktX/g7yWTJsEKq7ccOVo2JbfnB1rYlVKK52faQvw/W34LG7u3MArRV7mGtll4Gc=
- ssh_host_key_ecdsa_public_keytype: ecdsa-sha2-nistp256
- ssh_host_key_ed25519_public: AAAAC3NzaC1lZDI1NTE5AAAAIEqirZU8jupDZ8wJylI4U2fqx3cFNfCUhZB1u4PKnJnW
- ssh_host_key_ed25519_public_keytype: ssh-ed25519
- ssh_host_key_rsa_public: AAAAB3NzaC1yc2EAAAADAQABAAABgQDR3MCoxjeeZzPx+bhSkYBC7naJddiDaKB8v9WNqhDlrdu4AkNK1jqdBgWY4pfTG4+x3ZF//rWgAVVVD2Laih8ErlGmhJOPB4hO9SfB7OBUK5uZaD5jRIl5tvqca9GZboXL4WczjQFTA/0mJJ1uAdGiolkmdyv8tKU92C4OioU4UN9q0bOk+H1yuiwKY3EjRxxrcC3Sxjr63Ojew5SJZsqG+J5dGJI7M63NaePTS3rjrIWcmGjfUQa0vLuZ8uTqsxh3IB2tyNuOlov0ybrKPk5JGmtpvhA2Z6D5TmNOgyHEYqM1CrArcZmCX9EVfly+YQ7NCOLoPKKGOqqKOTuw2ygIZuTOt4IGLDXMiMUgkTECAwUuWykeUwhXOeVSyiMknIuCn/ui1/gQU5JKvhsqNko4hNZKerBGe1wu4upZd7tAsQ63ppEO+tQvy5o4BUudZQtdSQc01WzO0RyRcx1NRIJaezzhGa22naKgaf9zER/hRyypNZNmuLlHhVs6fyXvjPM=
- ssh_host_key_rsa_public_keytype: ssh-rsa
- swapfree_mb: 1639
- swaptotal_mb: 1639
- system: Linux
- system_capabilities_enforced: True
- system_vendor: VMware, Inc.
- uptime_seconds: 331832
- user_dir: /root
- user_gecos: root
- user_gid: 0
- user_id: root
- user_shell: /bin/bash
- user_uid: 0
- userspace_architecture: x86_64
- userspace_bits: 64
- virtualization_role: guest
- virtualization_type: VMware
- discovered_interpreter_python: /usr/libexec/platform-python
- module_setup: True
#
All_Ipv4_Addresses
- 0: 123.123.123.123
#
All_Ipv6_Addresses
- 0: 11:11:11:11:11:11:11:11
- 1: 11:11:11:11:11:11:11:12
#
Apparmor
- status: disabled
#
Cmdline
- BOOT_IMAGE: (hd0,msdos1)/vmlinuz-4.18.0-193.28.1.el8_2.x86_64
- quiet: True
- rd.lvm.lv: cs/swap
- resume: /dev/mapper/cs-swap
- rhgb: True
- ro: True
- root: /dev/mapper/cs-root
#
Date_Time
- date: 2021-07-08
- day: 08
- epoch: 1625721772
- hour: 14
- iso8601: 2021-07-08T05:22:52Z
- iso8601_basic: 20210708T142252659998
- iso8601_basic_short: 20210708T142252
- iso8601_micro: 2021-07-08T05:22:52.659998Z
- minute: 22
- month: 07
- second: 52
- time: 14:22:52
- tz: JST
- tz_offset: +0900
- weekday: Thursday
- weekday_number: 4
- weeknumber: 27
- year: 2021
#
Default_Ipv4
- address: 123.123.123.123
- alias: ens192
- broadcast: 192.168.1.255
- gateway: 192.168.1.1
- interface: ens192
- macaddress: 00:0c:29:bb:37:cb
- mtu: 1500
- netmask: 255.255.255.0
- network: 192.168.1.0
- type: ether
#
Default_Ipv6#
Device_Links#
Devices#
Dns#
Ens192
- active: True
- device: ens192
- macaddress: 00:0c:29:bb:37:cb
- module: vmxnet3
- mtu: 1500
- pciid: 0000:0b:00.0
- promisc: False
- speed: 10000
- type: ether
#
Features
- esp_hw_offload: off [fixed]
- esp_tx_csum_hw_offload: off [fixed]
- fcoe_mtu: off [fixed]
- generic_receive_offload: on
- generic_segmentation_offload: on
- highdma: on
- hw_tc_offload: off [fixed]
- l2_fwd_offload: off [fixed]
- large_receive_offload: on
- loopback: off [fixed]
- netns_local: off [fixed]
- ntuple_filters: off [fixed]
- receive_hashing: off [fixed]
- rx_all: off [fixed]
- rx_checksumming: on
- rx_fcs: off [fixed]
- rx_gro_hw: off [fixed]
- rx_udp_tunnel_port_offload: off [fixed]
- rx_vlan_filter: on [fixed]
- rx_vlan_offload: on
- rx_vlan_stag_filter: off [fixed]
- rx_vlan_stag_hw_parse: off [fixed]
- scatter_gather: on
- tcp_segmentation_offload: on
- tls_hw_record: off [fixed]
- tls_hw_rx_offload: off [fixed]
- tls_hw_tx_offload: off [fixed]
- tx_checksum_fcoe_crc: off [fixed]
- tx_checksum_ip_generic: on
- tx_checksum_ipv4: off [fixed]
- tx_checksum_ipv6: off [fixed]
- tx_checksum_sctp: off [fixed]
- tx_checksumming: on
- tx_esp_segmentation: off [fixed]
- tx_fcoe_segmentation: off [fixed]
- tx_gre_csum_segmentation: off [fixed]
- tx_gre_segmentation: off [fixed]
- tx_gso_partial: off [fixed]
- tx_gso_robust: off [fixed]
- tx_ipxip4_segmentation: off [fixed]
- tx_ipxip6_segmentation: off [fixed]
- tx_lockless: off [fixed]
- tx_nocache_copy: off
- tx_scatter_gather: on
- tx_scatter_gather_fraglist: off [fixed]
- tx_sctp_segmentation: off [fixed]
- tx_tcp6_segmentation: on
- tx_tcp_ecn_segmentation: off [fixed]
- tx_tcp_mangleid_segmentation: off
- tx_tcp_segmentation: on
- tx_udp_segmentation: off [fixed]
- tx_udp_tnl_csum_segmentation: off [fixed]
- tx_udp_tnl_segmentation: off [fixed]
- tx_vlan_offload: on
- tx_vlan_stag_hw_insert: off [fixed]
- vlan_challenged: off [fixed]
#
Hw_Timestamp_Filters#
Ipv4
- address: 123.123.123.123
- broadcast: 192.168.1.255
- netmask: 255.255.255.0
- network: 192.168.1.0
#
Ipv6#
List
- address: 11:11:11:11:11:11:11:11
- prefix: 64
- scope: global
#
List
- address: 11:11:11:11:11:11:11:12
- prefix: 64
- scope: link
#
Timestamping
- 0: rx_software
- 1: software
#
Fibre_Channel_Wwn#
Interfaces
- 0: lo
- 1: ens192
#
Lo
- active: True
- device: lo
- mtu: 65536
- promisc: False
- type: loopback
#
Features
- esp_hw_offload: off [fixed]
- esp_tx_csum_hw_offload: off [fixed]
- fcoe_mtu: off [fixed]
- generic_receive_offload: on
- generic_segmentation_offload: on
- highdma: on [fixed]
- hw_tc_offload: off [fixed]
- l2_fwd_offload: off [fixed]
- large_receive_offload: off [fixed]
- loopback: on [fixed]
- netns_local: on [fixed]
- ntuple_filters: off [fixed]
- receive_hashing: off [fixed]
- rx_all: off [fixed]
- rx_checksumming: on [fixed]
- rx_fcs: off [fixed]
- rx_gro_hw: off [fixed]
- rx_udp_tunnel_port_offload: off [fixed]
- rx_vlan_filter: off [fixed]
- rx_vlan_offload: off [fixed]
- rx_vlan_stag_filter: off [fixed]
- rx_vlan_stag_hw_parse: off [fixed]
- scatter_gather: on
- tcp_segmentation_offload: on
- tls_hw_record: off [fixed]
- tls_hw_rx_offload: off [fixed]
- tls_hw_tx_offload: off [fixed]
- tx_checksum_fcoe_crc: off [fixed]
- tx_checksum_ip_generic: on [fixed]
- tx_checksum_ipv4: off [fixed]
- tx_checksum_ipv6: off [fixed]
- tx_checksum_sctp: on [fixed]
- tx_checksumming: on
- tx_esp_segmentation: off [fixed]
- tx_fcoe_segmentation: off [fixed]
- tx_gre_csum_segmentation: off [fixed]
- tx_gre_segmentation: off [fixed]
- tx_gso_partial: off [fixed]
- tx_gso_robust: off [fixed]
- tx_ipxip4_segmentation: off [fixed]
- tx_ipxip6_segmentation: off [fixed]
- tx_lockless: on [fixed]
- tx_nocache_copy: off [fixed]
- tx_scatter_gather: on [fixed]
- tx_scatter_gather_fraglist: on [fixed]
- tx_sctp_segmentation: on
- tx_tcp6_segmentation: on
- tx_tcp_ecn_segmentation: on
- tx_tcp_mangleid_segmentation: on
- tx_tcp_segmentation: on
- tx_udp_segmentation: off [fixed]
- tx_udp_tnl_csum_segmentation: off [fixed]
- tx_udp_tnl_segmentation: off [fixed]
- tx_vlan_offload: off [fixed]
- tx_vlan_stag_hw_insert: off [fixed]
- vlan_challenged: on [fixed]
#
Hw_Timestamp_Filters#
Ipv4
- address: 127.0.0.1
- broadcast:
- netmask: 255.0.0.0
- network: 127.0.0.0
#
Ipv6#
List
- address: ::1
- prefix: 128
- scope: host
#
Timestamping
- 0: tx_software
- 1: rx_software
- 2: software
#
Local#
Lsb#
Lvm#
Memory_Mb#
Mounts#
9Cf80Eb1-50Cf-48E5-Af07-49D65717Fab7
- block_available: 3057926
- block_size: 4096
- block_total: 3508736
- block_used: 450810
- device: /dev/mapper/cs-root
- fstype: xfs
- inode_available: 6985488
- inode_total: 7022592
- inode_used: 37104
- mount: /
- options: rw,seclabel,relatime,attr2,inode64,noquota
- size_available: 12525264896
- size_total: 14371782656
- uuid: 9cf80eb1-50cf-48e5-af07-49d65717fab7
#
99851642-260F-4D7E-83Dd-7Cc990D49126
- block_available: 201086
- block_size: 4096
- block_total: 249830
- block_used: 48744
- device: /dev/sda1
- fstype: ext4
- inode_available: 65227
- inode_total: 65536
- inode_used: 309
- mount: /boot
- options: rw,seclabel,relatime
- size_available: 823648256
- size_total: 1023303680
- uuid: 99851642-260f-4d7e-83dd-7cc990d49126
#
Proc_Cmdline
- BOOT_IMAGE: (hd0,msdos1)/vmlinuz-4.18.0-193.28.1.el8_2.x86_64
- quiet: True
- resume: /dev/mapper/cs-swap
- rhgb: True
- ro: True
- root: /dev/mapper/cs-root
#
Rd.Lvm.Lv
- 0: cs/root
- 1: cs/swap
#
Processor
- 0: 0
- 1: GenuineIntel
- 2: Intel(R) Core(TM) i7 CPU 920 @ 2.67GHz
#
Python#
Selinux
- config_mode: enforcing
- mode: enforcing
- policyvers: 31
- status: enabled
- type: targeted
#
System_Capabilities
- 0: cap_chown
#
Gather_Subset
- 0: all
#
linux-gconftool2Edit GNOME Configurations Further documentation available at https://docs.ansible.com/ansible/2.9/modules/gconftool2_module.html
#
Base Commandlinux-gconftool2
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
key | A GConf preference key is an element in the GConf repository that corresponds to an application preference. See man gconftool-2(1). | Required |
value | Preference keys typically have simple values such as strings, integers, or lists of strings and integers. This is ignored if the state is "get". See man gconftool-2(1). | Optional |
value_type | The type of value being set. This is ignored if the state is "get". Possible values are: bool, float, int, string. | Optional |
state | The action to take upon the key/value. Possible values are: absent, get, present. | Required |
config_source | Specify a configuration source to use rather than the default path. See man gconftool-2(1). | Optional |
direct | Access the config database directly, bypassing server. If direct is specified then the config_source must be specified as well. See man gconftool-2(1). Default is no. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Gconftool2.key | string | The key specified in the module parameters |
Linux.Gconftool2.value_type | string | The type of the value that was changed |
Linux.Gconftool2.value | string | The value of the preference key after executing the module |
#
Command Example!linux-gconftool2 host="123.123.123.123" key="/desktop/gnome/interface/font_name" value_type="string" value="Serif 12" state=present
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
linux-getentA wrapper to the unix getent utility Further documentation available at https://docs.ansible.com/ansible/2.9/modules/getent_module.html
#
Base Commandlinux-getent
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
database | The name of a getent database supported by the target system (passwd, group, hosts, etc). | Required |
key | Key from which to return values from the specified database, otherwise the full contents are returned. | Optional |
service | Override all databases with the specified service The underlying system must support the service flag which is not always available. | Optional |
split | Character used to split the database values into lists/arrays such as ':' or ' ', otherwise it will try to pick one depending on the database. | Optional |
fail_key | If a supplied key is missing this will make the task fail if yes . Default is yes. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-getent host="123.123.123.123" database="passwd" key="root"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
linux-groupAdd or remove groups Further documentation available at https://docs.ansible.com/ansible/2.9/modules/group_module.html
#
Base Commandlinux-group
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of the group to manage. | Required |
gid | Optional GID to set for the group. | Optional |
state | Whether the group should be present or not on the remote host. Possible values are: absent, present. Default is present. | Optional |
system | If yes , indicates that the group created is a system group. Possible values are: Yes, No. Default is No. | Optional |
local | Forces the use of "local" command alternatives on platforms that implement it. This is useful in environments that use centralized authentication when you want to manipulate the local groups. (e.g. it uses lgroupadd instead of groupadd ).This requires that these commands exist on the targeted host, otherwise it will be a fatal error. Possible values are: Yes, No. Default is No. | Optional |
non_unique | This option allows to change the group ID to a non-unique value. Requires gid .Not supported on macOS or BusyBox distributions. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-group host="123.123.123.123" name="somegroup" state="present"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- gid: 1000
- name: somegroup
- state: present
- system: False
#
linux-hostnameManage hostname Further documentation available at https://docs.ansible.com/ansible/2.9/modules/hostname_module.html
#
Base Commandlinux-hostname
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of the host. | Required |
use | Which strategy to use to update the hostname. If not set we try to autodetect, but this can be problematic, specially with containers as they can present misleading information. Possible values are: generic, debian, sles, redhat, alpine, systemd, openrc, openbsd, solaris, freebsd. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-hostname host="123.123.123.123" name="web01"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- name: web01
#
linux-interfaces-fileTweak settings in /etc/network/interfaces files Further documentation available at https://docs.ansible.com/ansible/2.9/modules/interfaces_file_module.html
#
Base Commandlinux-interfaces-file
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
dest | Path to the interfaces file. Default is /etc/network/interfaces. | Optional |
iface | Name of the interface, required for value changes or option remove. | Optional |
address_family | Address family of the interface, useful if same interface name is used for both inet and inet6. | Optional |
option | Name of the option, required for value changes or option remove. | Optional |
value | If option is not presented for the interface and state is present option will be added. If option already exists and is not pre-up , up , post-up or down , it's value will be updated. pre-up , up , post-up and down options can't be updated, only adding new options, removing existing ones or cleaning the whole option set are supported. | Optional |
backup | Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. Default is no. | Optional |
state | If set to absent the option or section will be removed if present instead of created. Possible values are: present, absent. Default is present. | Optional |
mode | The permissions the resulting file or directory should have. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like 0644 or 01777 ) or quote it (like '644' or '1777' ) so Ansible receives a string and can do its own conversion from string into number.Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r ). | Optional |
owner | Name of the user that should own the file/directory, as would be fed to chown . | Optional |
group | Name of the group that should own the file/directory, as would be fed to chown . | Optional |
seuser | The user part of the SELinux file context. By default it uses the system policy, where applicable.When set to _default , it will use the user portion of the policy if available. | Optional |
serole | The role part of the SELinux file context. When set to _default , it will use the role portion of the policy if available. | Optional |
setype | The type part of the SELinux file context. When set to _default , it will use the type portion of the policy if available. | Optional |
selevel | The level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range .When set to _default , it will use the level portion of the policy if available. Default is s0. | Optional |
unsafe_writes | Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. This option allows Ansible to fall back to unsafe methods of updating files when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes). IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. Possible values are: Yes, No. Default is No. | Optional |
attributes | The attributes the resulting file or directory should have. To get supported flags look at the man page for chattr on the target system.This string should contain the attributes in the same order as the one displayed by lsattr .The = operator is assumed as default, otherwise + or - operators need to be included in the string. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.InterfacesFile.dest | string | destination file/path |
Linux.InterfacesFile.ifaces | unknown | interfaces dictionary |
#
linux-iptablesModify iptables rules Further documentation available at https://docs.ansible.com/ansible/2.9/modules/iptables_module.html
#
Base Commandlinux-iptables
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
table | This option specifies the packet matching table which the command should operate on. If the kernel is configured with automatic module loading, an attempt will be made to load the appropriate module for that table if it is not already there. Possible values are: filter, nat, mangle, raw, security. Default is filter. | Optional |
state | Whether the rule should be absent or present. Possible values are: absent, present. Default is present. | Optional |
action | Whether the rule should be appended at the bottom or inserted at the top. If the rule already exists the chain will not be modified. Possible values are: append, insert. Default is append. | Optional |
rule_num | Insert the rule as the given rule number. This works only with action=insert . | Optional |
ip_version | Which version of the IP protocol this rule should apply to. Possible values are: ipv4, ipv6. Default is ipv4. | Optional |
chain | Specify the iptables chain to modify. This could be a user-defined chain or one of the standard iptables chains, like INPUT , FORWARD , OUTPUT , PREROUTING , POSTROUTING , SECMARK or CONNSECMARK . | Optional |
protocol | The protocol of the rule or of the packet to check. The specified protocol can be one of tcp , udp , udplite , icmp , esp , ah , sctp or the special keyword all , or it can be a numeric value, representing one of these protocols or a different one.A protocol name from /etc/protocols is also allowed.A ! argument before the protocol inverts the test.The number zero is equivalent to all. all will match with all protocols and is taken as default when this option is omitted. | Optional |
source | Source specification. Address can be either a network name, a hostname, a network IP address (with /mask), or a plain IP address. Hostnames will be resolved once only, before the rule is submitted to the kernel. Please note that specifying any name to be resolved with a remote query such as DNS is a really bad idea. The mask can be either a network mask or a plain number, specifying the number of 1's at the left side of the network mask. Thus, a mask of 24 is equivalent to 255.255.255.0. A ! argument before the address specification inverts the sense of the address. | Optional |
destination | Destination specification. Address can be either a network name, a hostname, a network IP address (with /mask), or a plain IP address. Hostnames will be resolved once only, before the rule is submitted to the kernel. Please note that specifying any name to be resolved with a remote query such as DNS is a really bad idea. The mask can be either a network mask or a plain number, specifying the number of 1's at the left side of the network mask. Thus, a mask of 24 is equivalent to 255.255.255.0. A ! argument before the address specification inverts the sense of the address. | Optional |
tcp_flags | TCP flags specification.tcp_flags expects a dict with the two keys flags and flags_set . | Optional |
match | Specifies a match to use, that is, an extension module that tests for a specific property. The set of matches make up the condition under which a target is invoked. Matches are evaluated first to last if specified as an array and work in short-circuit fashion, i.e. if one extension yields false, evaluation will stop. | Optional |
jump | This specifies the target of the rule; i.e., what to do if the packet matches it. The target can be a user-defined chain (other than the one this rule is in), one of the special builtin targets which decide the fate of the packet immediately, or an extension (see EXTENSIONS below). If this option is omitted in a rule (and the goto parameter is not used), then matching the rule will have no effect on the packet's fate, but the counters on the rule will be incremented. | Optional |
gateway | This specifies the IP address of host to send the cloned packets. This option is only valid when jump is set to TEE . | Optional |
log_prefix | Specifies a log text for the rule. Only make sense with a LOG jump. | Optional |
log_level | Logging level according to the syslogd-defined priorities. The value can be strings or numbers from 1-8. This parameter is only applicable if jump is set to LOG . Possible values are: 0, 1, 2, 3, 4, 5, 6, 7, emerg, alert, crit, error, warning, notice, info, debug. | Optional |
goto | This specifies that the processing should continue in a user specified chain. Unlike the jump argument return will not continue processing in this chain but instead in the chain that called us via jump. | Optional |
in_interface | Name of an interface via which a packet was received (only for packets entering the INPUT , FORWARD and PREROUTING chains).When the ! argument is used before the interface name, the sense is inverted.If the interface name ends in a + , then any interface which begins with this name will match.If this option is omitted, any interface name will match. | Optional |
out_interface | Name of an interface via which a packet is going to be sent (for packets entering the FORWARD , OUTPUT and POSTROUTING chains).When the ! argument is used before the interface name, the sense is inverted.If the interface name ends in a + , then any interface which begins with this name will match.If this option is omitted, any interface name will match. | Optional |
fragment | This means that the rule only refers to second and further fragments of fragmented packets. Since there is no way to tell the source or destination ports of such a packet (or ICMP type), such a packet will not match any rules which specify them. When the "!" argument precedes fragment argument, the rule will only match head fragments, or unfragmented packets. | Optional |
set_counters | This enables the administrator to initialize the packet and byte counters of a rule (during INSERT , APPEND , REPLACE operations). | Optional |
source_port | Source port or port range specification. This can either be a service name or a port number. An inclusive range can also be specified, using the format first:last .If the first port is omitted, 0 is assumed; if the last is omitted, 65535 is assumed.If the first port is greater than the second one they will be swapped. | Optional |
destination_port | Destination port or port range specification. This can either be a service name or a port number. An inclusive range can also be specified, using the format first:last. If the first port is omitted, '0' is assumed; if the last is omitted, '65535' is assumed. If the first port is greater than the second one they will be swapped. This is only valid if the rule also specifies one of the following protocols: tcp, udp, dccp or sctp. | Optional |
to_ports | This specifies a destination port or range of ports to use, without this, the destination port is never altered. This is only valid if the rule also specifies one of the protocol tcp , udp , dccp or sctp . | Optional |
to_destination | This specifies a destination address to use with DNAT .Without this, the destination address is never altered. | Optional |
to_source | This specifies a source address to use with SNAT .Without this, the source address is never altered. | Optional |
syn | This allows matching packets that have the SYN bit set and the ACK and RST bits unset. When negated, this matches all packets with the RST or the ACK bits set. Possible values are: ignore, match, negate. Default is ignore. | Optional |
set_dscp_mark | This allows specifying a DSCP mark to be added to packets. It takes either an integer or hex value. Mutually exclusive with set_dscp_mark_class . | Optional |
set_dscp_mark_class | This allows specifying a predefined DiffServ class which will be translated to the corresponding DSCP mark. Mutually exclusive with set_dscp_mark . | Optional |
comment | This specifies a comment that will be added to the rule. | Optional |
ctstate | ctstate is a list of the connection states to match in the conntrack module.Possible states are INVALID , NEW , ESTABLISHED , RELATED , UNTRACKED , SNAT , DNAT . | Optional |
src_range | Specifies the source IP range to match in the iprange module. | Optional |
dst_range | Specifies the destination IP range to match in the iprange module. | Optional |
limit | Specifies the maximum average number of matches to allow per second. The number can specify units explicitly, using /second', /minute', /hour' or /day', or parts of them (so 5/second' is the same as 5/s'). | Optional |
limit_burst | Specifies the maximum burst before the above limit kicks in. | Optional |
uid_owner | Specifies the UID or username to use in match by owner rule. From Ansible 2.6 when the ! argument is prepended then the it inverts the rule to apply instead to all users except that one specified. | Optional |
gid_owner | Specifies the GID or group to use in match by owner rule. | Optional |
reject_with | Specifies the error packet type to return while rejecting. It implies "jump: REJECT". | Optional |
icmp_type | This allows specification of the ICMP type, which can be a numeric ICMP type, type/code pair, or one of the ICMP type names shown by the command 'iptables -p icmp -h'. | Optional |
flush | Flushes the specified table and chain of all rules. If no chain is specified then the entire table is purged. Ignores all other parameters. | Optional |
policy | Set the policy for the chain to the given target. Only built-in chains can have policies. This parameter requires the chain parameter.Ignores all other parameters. Possible values are: ACCEPT, DROP, QUEUE, RETURN. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-iptables host="123.123.123.123" chain="INPUT" source="8.8.8.8" jump="DROP"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- chain: INPUT
- changed: False
- flush: False
- ip_version: ipv4
- rule: -s 8.8.8.8 -j DROP
- state: present
- table: filter
#
linux-java-certUses keytool to import/remove key from java keystore (cacerts) Further documentation available at https://docs.ansible.com/ansible/2.9/modules/java_cert_module.html
#
Base Commandlinux-java-cert
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
cert_url | Basic URL to fetch SSL certificate from. One of cert_url or cert_path is required to load certificate. | Optional |
cert_port | Port to connect to URL. This will be used to create server URL:PORT. Default is 443. | Optional |
cert_path | Local path to load certificate from. One of cert_url or cert_path is required to load certificate. | Optional |
cert_alias | Imported certificate alias. The alias is used when checking for the presence of a certificate in the keystore. | Optional |
pkcs12_path | Local path to load PKCS12 keystore from. | Optional |
pkcs12_password | Password for importing from PKCS12 keystore. | Optional |
pkcs12_alias | Alias in the PKCS12 keystore. | Optional |
keystore_path | Path to keystore. | Optional |
keystore_pass | Keystore password. | Required |
keystore_create | Create keystore if it does not exist. | Optional |
keystore_type | Keystore type (JCEKS, JKS). | Optional |
executable | Path to keytool binary if not used we search in PATH for it. Default is keytool. | Optional |
state | Defines action which can be either certificate import or removal. Possible values are: absent, present. Default is present. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.JavaCert.msg | string | Output from stdout of keytool command after execution of given command. |
Linux.JavaCert.rc | number | Keytool command execution return value. |
Linux.JavaCert.cmd | string | Executed command to get action done. |
#
Command Example!linux-java-cert host="123.123.123.123" cert_url="google.com" cert_port="443" keystore_path="/usr/lib/jvm/jre-1.8.0/lib/security/cacerts" keystore_pass="changeit" state="present"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
linux-java-keystoreCreate or delete a Java keystore in JKS format. Further documentation available at https://docs.ansible.com/ansible/2.9/modules/java_keystore_module.html
#
Base Commandlinux-java-keystore
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of the certificate. | Required |
certificate | Certificate that should be used to create the key store. | Required |
private_key | Private key that should be used to create the key store. | Required |
password | Password that should be used to secure the key store. | Required |
dest | Absolute path where the jks should be generated. | Required |
owner | Name of the user that should own jks file. | Optional |
group | Name of the group that should own jks file. | Optional |
mode | Mode the file should be. | Optional |
force | Key store will be created even if it already exists. Default is no. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.JavaKeystore.msg | string | Output from stdout of keytool/openssl command after execution of given command or an error. |
Linux.JavaKeystore.rc | number | keytool/openssl command execution return value |
Linux.JavaKeystore.cmd | string | Executed command to get action done |
#
Command Example!linux-java-keystore host="123.123.123.123" name="example" certificate="-----BEGIN CERTIFICATE-----\\nMIIB2zCCAYW...DDejA=\\n-----END CERTIFICATE-----" private_key="-----BEGIN PRIVATE KEY-----\\nMIIBVAIBADANBgkq...NGA56xjg=\\n-----END PRIVATE KEY-----" dest="/etc/security/keystore.jks" password="changeit"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
linux-kernel-blacklistDeny list kernel modules Further documentation available at https://docs.ansible.com/ansible/2.9/modules/kernel_blacklist_module.html
#
Base Commandlinux-kernel-blacklist
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of kernel module to add to block list or allow list. | Required |
state | Whether the module should be present in the block list or absent. Possible values are: absent, present. Default is present. | Optional |
blacklist_file | If specified, use this block list file instead of /etc/modprobe.d/blacklist-ansible.conf . | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-kernel-blacklist host="123.123.123.123" name="nouveau" state="present"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- name: nouveau
- state: present
#
linux-known-hostsAdd or remove a host from the C(known_hosts) file Further documentation available at https://docs.ansible.com/ansible/2.9/modules/known_hosts_module.html
#
Base Commandlinux-known-hosts
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | The host to add or remove (must match a host specified in key). It will be converted to lowercase so that ssh-keygen can find it. Must match with <hostname> or <ip> present in key attribute. | Required |
key | The SSH public host key, as a string (required if state=present, optional when state=absent, in which case all keys for the host are removed). The key must be in the right format for ssh (see sshd(8), section "SSH_KNOWN_HOSTS FILE FORMAT"). Specifically, the key should not match the format that is found in an SSH pubkey file, but should rather have the hostname prepended to a line that includes the pubkey, the same way that it would appear in the known_hosts file. The value prepended to the line must also match the value of the name parameter. Should be of format <hostname[,IP]> ssh-rsa <pubkey> . | Optional |
path | The known_hosts file to edit. Default is (homedir)+/.ssh/known_hosts. | Optional |
hash_host | Hash the hostname in the known_hosts file. Default is no. | Optional |
state | present to add the host key, absent to remove it. Possible values are: present, absent. Default is present. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-known-hosts host="123.123.123.123" path="/etc/ssh/ssh_known_hosts" name="host1.example.com" key="host1.example.com,10.9.8.77 ssh-rsa ASDeararAIUHI324324"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- gid: 0
- group: root
- hash_host: False
- key: host1.example.com,10.9.8.77 ssh-rsa ASDeararAIUHI324324
- mode: 0644
- name: host1.example.com
- owner: root
- path: /etc/ssh/ssh_known_hosts
- secontext: system_u:object_r:etc_t:s0
- size: 56
- state: file
- uid: 0
#
linux-listen-ports-factsGather facts on processes listening on TCP and UDP ports. Further documentation available at https://docs.ansible.com/ansible/2.9/modules/listen_ports_facts_module.html
#
Base Commandlinux-listen-ports-facts
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.ListenPortsFacts.facts | unknown | Dictionary containing details of TCP and UDP ports with listening servers |
#
Command Example!linux-listen-ports-facts host="123.123.123.123"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
#
linux-locale-genCreates or removes locales Further documentation available at https://docs.ansible.com/ansible/2.9/modules/locale_gen_module.html
#
Base Commandlinux-locale-gen
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name and encoding of the locale, such as "en_GB.UTF-8". | Required |
state | Whether the locale shall be present. Possible values are: absent, present. Default is present. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-modprobeLoad or unload kernel modules Further documentation available at https://docs.ansible.com/ansible/2.9/modules/modprobe_module.html
#
Base Commandlinux-modprobe
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of kernel module to manage. | Required |
state | Whether the module should be present or absent. Possible values are: absent, present. Default is present. | Optional |
params | Modules parameters. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-modprobe host="123.123.123.123" name="8021q" state="present"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- name: 8021q
- params:
- state: present
#
linux-mountControl active and configured mount points Further documentation available at https://docs.ansible.com/ansible/2.9/modules/mount_module.html
#
Base Commandlinux-mount
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
path | Path to the mount point (e.g. /mnt/files ).Before Ansible 2.3 this option was only usable as dest , destfile and name . | Required |
src | Device to be mounted on path .Required when state set to present or mounted . | Optional |
fstype | Filesystem type. Required when state is present or mounted . | Optional |
opts | Mount options (see fstab(5), or vfstab(4) on Solaris). | Optional |
dump | Dump (see fstab(5)). Note that if set to null and state set to present , it will cease to work and duplicate entries will be made with subsequent runs.Has no effect on Solaris systems. Default is 0. | Optional |
passno | Passno (see fstab(5)). Note that if set to null and state set to present , it will cease to work and duplicate entries will be made with subsequent runs.Deprecated on Solaris systems. Default is 0. | Optional |
state | If mounted , the device will be actively mounted and appropriately configured in fstab . If the mount point is not present, the mount point will be created.If unmounted , the device will be unmounted without changing fstab .present only specifies that the device is to be configured in fstab and does not trigger or require a mount.absent specifies that the device mount's entry will be removed from fstab and will also unmount the device and remove the mount point.remounted specifies that the device will be remounted for when you want to force a refresh on the mount itself (added in 2.9). This will always return changed=true. Possible values are: absent, mounted, present, unmounted, remounted. | Required |
fstab | File to use instead of /etc/fstab .You should not use this option unless you really know what you are doing. This might be useful if you need to configure mountpoints in a chroot environment. OpenBSD does not allow specifying alternate fstab files with mount so do not use this on OpenBSD with any state that operates on the live filesystem. This parameter defaults to /etc/fstab or /etc/vfstab on Solaris. | Optional |
boot | Determines if the filesystem should be mounted on boot. Only applies to Solaris systems. Possible values are: Yes, No. Default is Yes. | Optional |
backup | Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-mount host="123.123.123.123" path="/mnt/dvd" "src"="/dev/sr0" fstype="iso9660" opts="ro,noauto" state="present"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- dump: 0
- fstab: /etc/fstab
- fstype: iso9660
- name: /mnt/dvd
- opts: ro,noauto
- passno: 0
- src: /dev/sr0
#
linux-open-iscsiManage iSCSI targets with Open-iSCSI Further documentation available at https://docs.ansible.com/ansible/2.9/modules/open_iscsi_module.html
#
Base Commandlinux-open-iscsi
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
portal | The IP address of the iSCSI target. | Optional |
port | The port on which the iSCSI target process listens. Default is 3260. | Optional |
target | The iSCSI target name. | Optional |
login | Whether the target node should be connected. | Optional |
node_auth | The value for discovery.sendtargets.auth.authmethod . Default is CHAP. | Optional |
node_user | The value for discovery.sendtargets.auth.username . | Optional |
node_pass | The value for discovery.sendtargets.auth.password . | Optional |
auto_node_startup | Whether the target node should be automatically connected at startup. | Optional |
discover | Whether the list of target nodes on the portal should be (re)discovered and added to the persistent iSCSI database. Keep in mind that iscsiadm discovery resets configuration, like node.startup to manual, hence combined with auto_node_startup=yes will always return a changed state. | Optional |
show_nodes | Whether the list of nodes in the persistent iSCSI database should be returned by the module. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-pam-limitsModify Linux PAM limits Further documentation available at https://docs.ansible.com/ansible/2.9/modules/pam_limits_module.html
#
Base Commandlinux-pam-limits
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
domain | A username, @groupname, wildcard, uid/gid range. | Required |
limit_type | Limit type, see man 5 limits.conf for an explanation. Possible values are: hard, soft, -. | Required |
limit_item | The limit to be set. Possible values are: core, data, fsize, memlock, nofile, rss, stack, cpu, nproc, as, maxlogins, maxsyslogins, priority, locks, sigpending, msgqueue, nice, rtprio, chroot. | Required |
value | The value of the limit. | Required |
backup | Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. Default is no. | Optional |
use_min | If set to yes , the minimal value will be used or conserved. If the specified value is inferior to the value in the file, file content is replaced with the new value, else content is not modified. Default is no. | Optional |
use_max | If set to yes , the maximal value will be used or conserved. If the specified value is superior to the value in the file, file content is replaced with the new value, else content is not modified. Default is no. | Optional |
dest | Modify the limits.conf path. Default is /etc/security/limits.conf. | Optional |
comment | Comment associated with the limit. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-pam-limits host="123.123.123.123" domain="joe" limit_type="soft" limit_item="nofile" value="64000"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- msg: joe soft nofile 64000
#
linux-pamdManage PAM Modules Further documentation available at https://docs.ansible.com/ansible/2.9/modules/pamd_module.html
#
Base Commandlinux-pamd
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | The name generally refers to the PAM service file to change, for example system-auth. | Required |
type | The type of the PAM rule being modified. The type , control and module_path all must match a rule to be modified. Possible values are: account, -account, auth, -auth, password, -password, session, -session. | Required |
control | The control of the PAM rule being modified. This may be a complicated control with brackets. If this is the case, be sure to put "[bracketed controls]" in quotes. The type , control and module_path all must match a rule to be modified. | Required |
module_path | The module path of the PAM rule being modified. The type , control and module_path all must match a rule to be modified. | Required |
new_type | The new type to assign to the new rule. Possible values are: account, -account, auth, -auth, password, -password, session, -session. | Optional |
new_control | The new control to assign to the new rule. | Optional |
new_module_path | The new module path to be assigned to the new rule. | Optional |
module_arguments | When state is updated , the module_arguments will replace existing module_arguments.When state is args_absent args matching those listed in module_arguments will be removed.When state is args_present any args listed in module_arguments are added if missing from the existing rule.Furthermore, if the module argument takes a value denoted by = , the value will be changed to that specified in module_arguments. | Optional |
state | The default of updated will modify an existing rule if type, control and module_path all match an existing rule.With before , the new rule will be inserted before a rule matching type, control and module_path.Similarly, with after , the new rule will be inserted after an existing rulematching type, control and module_path.With either before or after new_type, new_control, and new_module_path must all be specified.If state is args_absent or args_present , new_type, new_control, and new_module_path will be ignored.State absent will remove the rule. The 'absent' state was added in Ansible 2.4. Possible values are: absent, before, after, args_absent, args_present, updated. Default is updated. | Optional |
path | This is the path to the PAM service files. Default is /etc/pam.d. | Optional |
backup | Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Pamd.change_count | number | How many rules were changed. |
Linux.Pamd.new_rule | string | The changes to the rule. This was available in Ansible 2.4 and Ansible 2.5. It was removed in Ansible 2.6. |
Linux.Pamd.updatedrule(n) | string | The rule(s) that was/were changed. This is only available in Ansible 2.4 and was removed in Ansible 2.5. |
Linux.Pamd.action | string | That action that was taken and is one of: update_rule, insert_before_rule, insert_after_rule, args_present, args_absent, absent. This was available in Ansible 2.4 and removed in Ansible 2.8 |
Linux.Pamd.dest | string | Path to pam.d service that was changed. This is only available in Ansible 2.3 and was removed in Ansible 2.4. |
Linux.Pamd.backupdest | string | The file name of the backup file, if created. |
#
Command Example!linux-pamd host="123.123.123.123" name="system-auth" type="auth" control="required" module_path="pam_faillock.so" new_control="sufficient"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- backupdest:
- change_count: 0
- changed: False
#
linux-partedConfigure block device partitions Further documentation available at https://docs.ansible.com/ansible/2.9/modules/parted_module.html
#
Base Commandlinux-parted
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
device | The block device (disk) where to operate. | Required |
align | Set alignment for newly created partitions. Possible values are: cylinder, minimal, none, optimal. Default is optimal. | Optional |
number | The number of the partition to work with or the number of the partition that will be created. Required when performing any action on the disk, except fetching information. | Optional |
unit | Selects the current default unit that Parted will use to display locations and capacities on the disk and to interpret those given by the user if they are not suffixed by an unit. When fetching information about a disk, it is always recommended to specify a unit. Possible values are: s, B, KB, KiB, MB, MiB, GB, GiB, TB, TiB, %, cyl, chs, compact. Default is KiB. | Optional |
label | Creates a new disk label. Possible values are: aix, amiga, bsd, dvh, gpt, loop, mac, msdos, pc98, sun. Default is msdos. | Optional |
part_type | May be specified only with 'msdos' or 'dvh' partition tables. A name must be specified for a 'gpt' partition table.Neither part_type nor name may be used with a 'sun' partition table. Possible values are: extended, logical, primary. Default is primary. | Optional |
part_start | Where the partition will start as offset from the beginning of the disk, that is, the "distance" from the start of the disk. The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, e.g. 10GiB , 15% . Default is 0%. | Optional |
part_end | Where the partition will end as offset from the beginning of the disk, that is, the "distance" from the start of the disk. The distance can be specified with all the units supported by parted (except compat) and it is case sensitive, e.g. 10GiB , 15% . Default is 100%. | Optional |
name | Sets the name for the partition number (GPT, Mac, MIPS and PC98 only). | Optional |
flags | A list of the flags that has to be set on the partition. | Optional |
state | Whether to create or delete a partition. If set to info the module will only return the device information. Possible values are: absent, present, info. Default is info. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Parted.partition_info | unknown | Current partition information |
#
Command Example!linux-parted host="123.123.123.123" device="/dev/sdb" number="1" state="present"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
#
linux-pidsRetrieves process IDs list if the process is running otherwise return empty list Further documentation available at https://docs.ansible.com/ansible/2.9/modules/pids_module.html
#
Base Commandlinux-pids
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | the name of the process you want to get PID for. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Pids.pids | unknown | Process IDs of the given process |
#
Command Example!linux-pids host="123.123.123.123" name="python"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
#
linux-pingTry to connect to host, verify a usable python and return C(pong) on success Further documentation available at https://docs.ansible.com/ansible/2.9/modules/ping_module.html
#
Base Commandlinux-ping
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
data | Data to return for the ping return value.If this parameter is set to crash , the module will cause an exception. Default is pong. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Ping.ping | string | value provided with the data parameter |
#
Command Example!linux-ping host="123.123.123.123"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
#
linux-python-requirements-infoShow python path and assert dependency versions Further documentation available at https://docs.ansible.com/ansible/2.9/modules/python_requirements_info_module.html
#
Base Commandlinux-python-requirements-info
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
dependencies | A list of version-likes or module names to check for installation. Supported operators: <, >, <=, >=, or ==. The bare module name like I(ansible), the module with a specific version like I(boto3==1.6.1), or a partial version like I(requests>2) are all valid specifications. . | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.PythonRequirementsInfo.python | string | path to python version used |
Linux.PythonRequirementsInfo.python_version | string | version of python |
Linux.PythonRequirementsInfo.python_system_path | unknown | List of paths python is looking for modules in |
Linux.PythonRequirementsInfo.valid | unknown | A dictionary of dependencies that matched their desired versions. If no version was specified, then `desired` will be null |
Linux.PythonRequirementsInfo.mismatched | unknown | A dictionary of dependencies that did not satisfy the desired version |
Linux.PythonRequirementsInfo.not_found | unknown | A list of packages that could not be imported at all, and are not installed |
#
Command Example!linux-python-requirements-info host="123.123.123.123"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- python: /usr/libexec/platform-python
- python_version: 3.6.8 (default, Aug 24 2020, 17:57:11) [GCC 8.3.1 20191121 (Red Hat 8.3.1-5)]
#
Mismatched#
Not_Found#
Python_System_Path
- 0: /tmp/python_requirements_info_payload_ppjh5d0o/python_requirements_info_payload.zip
- 1: /usr/lib64/python36.zip
- 2: /usr/lib64/python3.6
- 3: /usr/lib64/python3.6/lib-dynload
- 4: /usr/local/lib64/python3.6/site-packages
- 5: /usr/local/lib/python3.6/site-packages
- 6: /usr/lib64/python3.6/site-packages
- 7: /usr/lib/python3.6/site-packages
#
Valid
#
linux-rebootReboot a machine Further documentation available at https://docs.ansible.com/ansible/2.9/modules/reboot_module.html
#
Base Commandlinux-reboot
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
pre_reboot_delay | Seconds to wait before reboot. Passed as a parameter to the reboot command. On Linux, macOS and OpenBSD, this is converted to minutes and rounded down. If less than 60, it will be set to 0. On Solaris and FreeBSD, this will be seconds. Default is 0. | Optional |
post_reboot_delay | Seconds to wait after the reboot command was successful before attempting to validate the system rebooted successfully. This is useful if you want wait for something to settle despite your connection already working. Default is 0. | Optional |
reboot_timeout | Maximum seconds to wait for machine to reboot and respond to a test command. This timeout is evaluated separately for both reboot verification and test command success so the maximum execution time for the module is twice this amount. Default is 600. | Optional |
connect_timeout | Maximum seconds to wait for a successful connection to the managed hosts before trying again. If unspecified, the default setting for the underlying connection plugin is used. | Optional |
test_command | Command to run on the rebooted host and expect success from to determine the machine is ready for further tasks. Default is whoami. | Optional |
msg | Message to display to users before reboot. Default is Reboot initiated by Ansible. | Optional |
search_paths | Paths to search on the remote machine for the shutdown command.Only these paths will be searched for the shutdown command. PATH is ignored in the remote node when searching for the shutdown command. Default is ['/sbin', '/usr/sbin', '/usr/local/sbin']. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Reboot.rebooted | boolean | true if the machine was rebooted |
Linux.Reboot.elapsed | number | The number of seconds that elapsed waiting for the system to be rebooted. |
#
linux-sebooleanToggles SELinux booleans Further documentation available at https://docs.ansible.com/ansible/2.9/modules/seboolean_module.html
#
Base Commandlinux-seboolean
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of the boolean to configure. | Required |
persistent | Set to yes if the boolean setting should survive a reboot. Default is no. | Optional |
state | Desired boolean value. | Required |
ignore_selinux_state | Useful for scenarios (chrooted environment) that you can't get the real SELinux state. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-sefcontextManages SELinux file context mapping definitions Further documentation available at https://docs.ansible.com/ansible/2.9/modules/sefcontext_module.html
#
Base Commandlinux-sefcontext
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
target | Target path (expression). | Required |
ftype | The file type that should have SELinux contexts applied. The following file type options are available: a for all files,b for block devices,c for character devices,d for directories,f for regular files,l for symbolic links,p for named pipes,s for socket files. Possible values are: a, b, c, d, f, l, p, s. Default is a. | Optional |
setype | SELinux type for the specified target. | Required |
seuser | SELinux user for the specified target. | Optional |
selevel | SELinux range for the specified target. | Optional |
state | Whether the SELinux file context must be absent or present . Possible values are: absent, present. Default is present. | Optional |
reload | Reload SELinux policy after commit. Note that this does not apply SELinux file contexts to existing files. Possible values are: Yes, No. Default is Yes. | Optional |
ignore_selinux_state | Useful for scenarios (chrooted environment) that you can't get the real SELinux state. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-selinuxChange policy and state of SELinux Further documentation available at https://docs.ansible.com/ansible/2.9/modules/selinux_module.html
#
Base Commandlinux-selinux
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
policy | The name of the SELinux policy to use (e.g. targeted ) will be required if state is not disabled . | Optional |
state | The SELinux mode. Possible values are: disabled, enforcing, permissive. | Required |
configfile | The path to the SELinux configuration file, if non-standard. Default is /etc/selinux/config. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Selinux.msg | string | Messages that describe changes that were made. |
Linux.Selinux.configfile | string | Path to SELinux configuration file. |
Linux.Selinux.policy | string | Name of the SELinux policy. |
Linux.Selinux.state | string | SELinux mode. |
Linux.Selinux.reboot_required | boolean | Whether or not an reboot is required for the changes to take effect. |
#
Command Example!linux-selinux host="123.123.123.123" policy="targeted" state="enforcing"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- configfile: /etc/selinux/config
- msg:
- policy: targeted
- reboot_required: False
- state: enforcing
#
linux-selinux-permissiveChange permissive domain in SELinux policy Further documentation available at https://docs.ansible.com/ansible/2.9/modules/selinux_permissive_module.html
#
Base Commandlinux-selinux-permissive
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
domain | The domain that will be added or removed from the list of permissive domains. | Required |
permissive | Indicate if the domain should or should not be set as permissive. | Required |
no_reload | Disable reloading of the SELinux policy after making change to a domain's permissive setting. The default is no , which causes policy to be reloaded when a domain changes state.Reloading the policy does not work on older versions of the policycoreutils-python library, for example in EL 6.". Possible values are: Yes, No. Default is No. | Optional |
store | Name of the SELinux policy store to use. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-seloginManages linux user to SELinux user mapping Further documentation available at https://docs.ansible.com/ansible/2.9/modules/selogin_module.html
#
Base Commandlinux-selogin
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
login | a Linux user. | Required |
seuser | SELinux user name. | Required |
selevel | MLS/MCS Security Range (MLS/MCS Systems only) SELinux Range for SELinux login mapping defaults to the SELinux user record range. Default is s0. | Optional |
state | Desired mapping value. Possible values are: present, absent. Default is present. | Required |
reload | Reload SELinux policy after commit. Possible values are: Yes, No. Default is Yes. | Optional |
ignore_selinux_state | Run independent of selinux runtime state. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-seportManages SELinux network port type definitions Further documentation available at https://docs.ansible.com/ansible/2.9/modules/seport_module.html
#
Base Commandlinux-seport
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
ports | Ports or port ranges. Can be a list (since 2.6) or comma separated string. | Required |
proto | Protocol for the specified port. Possible values are: tcp, udp. | Required |
setype | SELinux type for the specified port. | Required |
state | Desired boolean value. Possible values are: absent, present. Default is present. | Optional |
reload | Reload SELinux policy after commit. Possible values are: Yes, No. Default is Yes. | Optional |
ignore_selinux_state | Run independent of selinux runtime state. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-serviceManage services Further documentation available at https://docs.ansible.com/ansible/2.9/modules/service_module.html
#
Base Commandlinux-service
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of the service. | Required |
state | started /stopped are idempotent actions that will not run commands unless necessary.restarted will always bounce the service.reloaded will always reload.At least one of state and enabled are required. Note that reloaded will start the service if it is not already started, even if your chosen init system wouldn't normally. Possible values are: reloaded, restarted, started, stopped. | Optional |
sleep | If the service is being restarted then sleep this many seconds between the stop and start command.This helps to work around badly-behaving init scripts that exit immediately after signaling a process to stop. Not all service managers support sleep, i.e when using systemd this setting will be ignored. | Optional |
pattern | If the service does not respond to the status command, name a substring to look for as would be found in the output of the ps command as a stand-in for a status result.If the string is found, the service will be assumed to be started. | Optional |
enabled | Whether the service should start on boot.At least one of state and enabled are required. . | Optional |
runlevel | For OpenRC init scripts (e.g. Gentoo) only. The runlevel that this service belongs to. Default is default. | Optional |
arguments | Additional arguments provided on the command line. | Optional |
use | The service module actually uses system specific modules, normally through auto detection, this setting can force a specific module. Normally it uses the value of the 'service_mgr' fact and falls back to the old 'service' module when none matching is found. Default is auto. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-service host="123.123.123.123" name="httpd" state="started"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
- name: httpd
- state: started
#
Status
- ActiveEnterTimestamp: Thu 2021-07-08 14:12:41 JST
- ActiveEnterTimestampMonotonic: 331222117201
- ActiveExitTimestampMonotonic: 0
- ActiveState: active
- After: system.slice basic.target systemd-journald.socket systemd-tmpfiles-setup.service -.mount nss-lookup.target remote-fs.target httpd-init.service sysinit.target network.target tmp.mount
- AllowIsolate: no
- AllowedCPUs:
- AllowedMemoryNodes:
- AmbientCapabilities:
- AssertResult: yes
- AssertTimestamp: Thu 2021-07-08 14:12:41 JST
- AssertTimestampMonotonic: 331221986103
- Before: shutdown.target
- BlockIOAccounting: no
- BlockIOWeight: [not set]
- CPUAccounting: no
- CPUAffinity:
- CPUQuotaPerSecUSec: infinity
- CPUSchedulingPolicy: 0
- CPUSchedulingPriority: 0
- CPUSchedulingResetOnFork: no
- CPUShares: [not set]
- CPUUsageNSec: [not set]
- CPUWeight: [not set]
- CacheDirectoryMode: 0755
- CanIsolate: no
- CanReload: yes
- CanStart: yes
- CanStop: yes
- CapabilityBoundingSet: cap_chown cap_dac_override cap_dac_read_search cap_fowner cap_fsetid cap_kill cap_setgid cap_setuid cap_setpcap cap_linux_immutable cap_net_bind_service cap_net_broadcast cap_net_admin cap_net_raw cap_ipc_lock cap_ipc_owner cap_sys_module cap_sys_rawio cap_sys_chroot cap_sys_ptrace cap_sys_pacct cap_sys_admin cap_sys_boot cap_sys_nice cap_sys_resource cap_sys_time cap_sys_tty_config cap_mknod cap_lease cap_audit_write cap_audit_control cap_setfcap cap_mac_override cap_mac_admin cap_syslog cap_wake_alarm cap_block_suspend
- CollectMode: inactive
- ConditionResult: yes
- ConditionTimestamp: Thu 2021-07-08 14:12:41 JST
- ConditionTimestampMonotonic: 331221986102
- ConfigurationDirectoryMode: 0755
- Conflicts: shutdown.target
- ControlGroup: /system.slice/httpd.service
- ControlPID: 0
- DefaultDependencies: yes
- Delegate: no
- Description: The Apache HTTP Server
- DevicePolicy: auto
- Documentation: man:httpd.service(8)
- DynamicUser: no
- EffectiveCPUs:
- EffectiveMemoryNodes:
- Environment: LANG=C
- ExecMainCode: 0
- ExecMainExitTimestampMonotonic: 0
- ExecMainPID: 7626
- ExecMainStartTimestamp: Thu 2021-07-08 14:12:41 JST
- ExecMainStartTimestampMonotonic: 331221988640
- ExecMainStatus: 0
- ExecReload: { path=/usr/sbin/httpd ; argv[]=/usr/sbin/httpd $OPTIONS -k graceful ; ignore_errors=no ; start_time=[n/a] ; stop_time=[n/a] ; pid=0 ; code=(null) ; status=0/0 }
- ExecStart: { path=/usr/sbin/httpd ; argv[]=/usr/sbin/httpd $OPTIONS -DFOREGROUND ; ignore_errors=no ; start_time=[Thu 2021-07-08 14:12:41 JST] ; stop_time=[n/a] ; pid=7626 ; code=(null) ; status=0/0 }
- FailureAction: none
- FileDescriptorStoreMax: 0
- FragmentPath: /usr/lib/systemd/system/httpd.service
- GID: [not set]
- GuessMainPID: yes
- IOAccounting: no
- IOSchedulingClass: 0
- IOSchedulingPriority: 0
- IOWeight: [not set]
- IPAccounting: no
- IPEgressBytes: 18446744073709551615
- IPEgressPackets: 18446744073709551615
- IPIngressBytes: 18446744073709551615
- IPIngressPackets: 18446744073709551615
- Id: httpd.service
- IgnoreOnIsolate: no
- IgnoreSIGPIPE: yes
- InactiveEnterTimestampMonotonic: 0
- InactiveExitTimestamp: Thu 2021-07-08 14:12:41 JST
- InactiveExitTimestampMonotonic: 331221988825
- InvocationID: 7bb9f1e196514d5f87dfb3602a1c9e32
- JobRunningTimeoutUSec: infinity
- JobTimeoutAction: none
- JobTimeoutUSec: infinity
- KeyringMode: private
- KillMode: mixed
- KillSignal: 28
- LimitAS: infinity
- LimitASSoft: infinity
- LimitCORE: infinity
- LimitCORESoft: infinity
- LimitCPU: infinity
- LimitCPUSoft: infinity
- LimitDATA: infinity
- LimitDATASoft: infinity
- LimitFSIZE: infinity
- LimitFSIZESoft: infinity
- LimitLOCKS: infinity
- LimitLOCKSSoft: infinity
- LimitMEMLOCK: 65536
- LimitMEMLOCKSoft: 65536
- LimitMSGQUEUE: 819200
- LimitMSGQUEUESoft: 819200
- LimitNICE: 0
- LimitNICESoft: 0
- LimitNOFILE: 262144
- LimitNOFILESoft: 1024
- LimitNPROC: 7805
- LimitNPROCSoft: 7805
- LimitRSS: infinity
- LimitRSSSoft: infinity
- LimitRTPRIO: 0
- LimitRTPRIOSoft: 0
- LimitRTTIME: infinity
- LimitRTTIMESoft: infinity
- LimitSIGPENDING: 7805
- LimitSIGPENDINGSoft: 7805
- LimitSTACK: infinity
- LimitSTACKSoft: 8388608
- LoadState: loaded
- LockPersonality: no
- LogLevelMax: -1
- LogRateLimitBurst: 0
- LogRateLimitIntervalUSec: 0
- LogsDirectoryMode: 0755
- MainPID: 7626
- MemoryAccounting: yes
- MemoryCurrent: 30425088
- MemoryDenyWriteExecute: no
- MemoryHigh: infinity
- MemoryLimit: infinity
- MemoryLow: 0
- MemoryMax: infinity
- MemorySwapMax: infinity
- MountAPIVFS: no
- MountFlags:
- NFileDescriptorStore: 0
- NRestarts: 0
- NUMAMask:
- NUMAPolicy: n/a
- Names: httpd.service
- NeedDaemonReload: no
- Nice: 0
- NoNewPrivileges: no
- NonBlocking: no
- NotifyAccess: main
- OOMScoreAdjust: 0
- OnFailureJobMode: replace
- PermissionsStartOnly: no
- Perpetual: no
- PrivateDevices: no
- PrivateMounts: no
- PrivateNetwork: no
- PrivateTmp: yes
- PrivateUsers: no
- ProtectControlGroups: no
- ProtectHome: no
- ProtectKernelModules: no
- ProtectKernelTunables: no
- ProtectSystem: no
- RefuseManualStart: no
- RefuseManualStop: no
- RemainAfterExit: no
- RemoveIPC: no
- Requires: system.slice sysinit.target -.mount
- RequiresMountsFor: /var/tmp
- Restart: no
- RestartUSec: 100ms
- RestrictNamespaces: no
- RestrictRealtime: no
- RestrictSUIDSGID: no
- Result: success
- RootDirectoryStartOnly: no
- RuntimeDirectoryMode: 0755
- RuntimeDirectoryPreserve: no
- RuntimeMaxUSec: infinity
- SameProcessGroup: no
- SecureBits: 0
- SendSIGHUP: no
- SendSIGKILL: yes
- Slice: system.slice
- StandardError: inherit
- StandardInput: null
- StandardInputData:
- StandardOutput: journal
- StartLimitAction: none
- StartLimitBurst: 5
- StartLimitIntervalUSec: 10s
- StartupBlockIOWeight: [not set]
- StartupCPUShares: [not set]
- StartupCPUWeight: [not set]
- StartupIOWeight: [not set]
- StateChangeTimestamp: Thu 2021-07-08 14:12:41 JST
- StateChangeTimestampMonotonic: 331222165344
- StateDirectoryMode: 0755
- StatusErrno: 0
- StatusText: Running, listening on: port 80
- StopWhenUnneeded: no
- SubState: running
- SuccessAction: none
- SyslogFacility: 3
- SyslogLevel: 6
- SyslogLevelPrefix: yes
- SyslogPriority: 30
- SystemCallErrorNumber: 0
- TTYReset: no
- TTYVHangup: no
- TTYVTDisallocate: no
- TasksAccounting: yes
- TasksCurrent: 213
- TasksMax: 12488
- TimeoutStartUSec: 1min 30s
- TimeoutStopUSec: 1min 30s
- TimerSlackNSec: 50000
- Transient: no
- Type: notify
- UID: [not set]
- UMask: 0022
- UnitFilePreset: disabled
- UnitFileState: disabled
- UtmpMode: init
- Wants: httpd-init.service
- WatchdogTimestamp: Thu 2021-07-08 14:12:41 JST
- WatchdogTimestampMonotonic: 331222117198
- WatchdogUSec: 0
#
linux-service-factsReturn service state information as fact data Further documentation available at https://docs.ansible.com/ansible/2.9/modules/service_facts_module.html
#
Base Commandlinux-service-facts
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.ServiceFacts.facts | unknown | Facts to add to facts about the services on the system |
#
Command Example!linux-service-facts host="123.123.123.123"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- discovered_interpreter_python: /usr/libexec/platform-python
#
Services
#
Networkmanager-Dispatcher.Service
- name: NetworkManager-dispatcher.service
- source: systemd
- state: inactive
- status: enabled
#
Networkmanager-Wait-Online.Service
- name: NetworkManager-wait-online.service
- source: systemd
- state: stopped
- status: enabled
#
Networkmanager.Service
- name: NetworkManager.service
- source: systemd
- state: running
- status: enabled
#
Arp-Ethers.Service
- name: arp-ethers.service
- source: systemd
- state: inactive
- status: disabled
#
Atd.Service
- name: atd.service
- source: systemd
- state: running
- status: enabled
#
Auditd.Service
- name: auditd.service
- source: systemd
- state: running
- status: enabled
Autovt@.Service#
- name: autovt@.service
- source: systemd
- state: unknown
- status: enabled
#
Blk-Availability.Service
- name: blk-availability.service
- source: systemd
- state: inactive
- status: disabled
Chrony-Dnssrv@.Service#
- name: chrony-dnssrv@.service
- source: systemd
- state: unknown
- status: static
#
Chrony-Wait.Service
- name: chrony-wait.service
- source: systemd
- state: inactive
- status: disabled
#
Chronyd.Service
- name: chronyd.service
- source: systemd
- state: running
- status: enabled
#
Console-Getty.Service
- name: console-getty.service
- source: systemd
- state: inactive
- status: disabled
Container-Getty@.Service#
- name: container-getty@.service
- source: systemd
- state: unknown
- status: static
#
Cpupower.Service
- name: cpupower.service
- source: systemd
- state: stopped
- status: disabled
#
Crond.Service
- name: crond.service
- source: systemd
- state: running
- status: enabled
#
Dbus-Org.Fedoraproject.Firewalld1.Service
- name: dbus-org.fedoraproject.FirewallD1.service
- source: systemd
- state: active
- status: enabled
#
Dbus-Org.Freedesktop.Hostname1.Service
- name: dbus-org.freedesktop.hostname1.service
- source: systemd
- state: inactive
- status: static
#
Dbus-Org.Freedesktop.Locale1.Service
- name: dbus-org.freedesktop.locale1.service
- source: systemd
- state: inactive
- status: static
#
Dbus-Org.Freedesktop.Login1.Service
- name: dbus-org.freedesktop.login1.service
- source: systemd
- state: active
- status: static
#
Dbus-Org.Freedesktop.Nm-Dispatcher.Service
- name: dbus-org.freedesktop.nm-dispatcher.service
- source: systemd
- state: inactive
- status: enabled
#
Dbus-Org.Freedesktop.Portable1.Service
- name: dbus-org.freedesktop.portable1.service
- source: systemd
- state: inactive
- status: static
#
Dbus-Org.Freedesktop.Timedate1.Service
- name: dbus-org.freedesktop.timedate1.service
- source: systemd
- state: inactive
- status: enabled
#
Dbus.Service
- name: dbus.service
- source: systemd
- state: running
- status: static
#
Debug-Shell.Service
- name: debug-shell.service
- source: systemd
- state: inactive
- status: disabled
#
Dm-Event.Service
- name: dm-event.service
- source: systemd
- state: stopped
- status: static
#
Dnf-Makecache.Service
- name: dnf-makecache.service
- source: systemd
- state: stopped
- status: static
#
Dracut-Cmdline.Service
- name: dracut-cmdline.service
- source: systemd
- state: stopped
- status: static
#
Dracut-Initqueue.Service
- name: dracut-initqueue.service
- source: systemd
- state: stopped
- status: static
#
Dracut-Mount.Service
- name: dracut-mount.service
- source: systemd
- state: stopped
- status: static
#
Dracut-Pre-Mount.Service
- name: dracut-pre-mount.service
- source: systemd
- state: stopped
- status: static
#
Dracut-Pre-Pivot.Service
- name: dracut-pre-pivot.service
- source: systemd
- state: stopped
- status: static
#
Dracut-Pre-Trigger.Service
- name: dracut-pre-trigger.service
- source: systemd
- state: stopped
- status: static
#
Dracut-Pre-Udev.Service
- name: dracut-pre-udev.service
- source: systemd
- state: stopped
- status: static
#
Dracut-Shutdown.Service
- name: dracut-shutdown.service
- source: systemd
- state: stopped
- status: static
#
Ebtables.Service
- name: ebtables.service
- source: systemd
- state: stopped
- status: disabled
#
Emergency.Service
- name: emergency.service
- source: systemd
- state: stopped
- status: static
#
Firewalld.Service
- name: firewalld.service
- source: systemd
- state: running
- status: enabled
#
Fstrim.Service
- name: fstrim.service
- source: systemd
- state: inactive
- status: static
Getty@.Service#
- name: getty@.service
- source: systemd
- state: unknown
- status: enabled
test@test.service#
- name: test@test.service
- source: systemd
- state: running
- status: unknown
#
Grub-Boot-Indeterminate.Service
- name: grub-boot-indeterminate.service
- source: systemd
- state: inactive
- status: static
#
Halt-Local.Service
- name: halt-local.service
- source: systemd
- state: inactive
- status: static
#
Htcacheclean.Service
- name: htcacheclean.service
- source: systemd
- state: inactive
- status: static
#
Httpd.Service
- name: httpd.service
- source: systemd
- state: running
- status: disabled
Httpd@.Service#
- name: httpd@.service
- source: systemd
- state: unknown
- status: disabled
#
Import-State.Service
- name: import-state.service
- source: systemd
- state: stopped
- status: enabled
#
Initrd-Cleanup.Service
- name: initrd-cleanup.service
- source: systemd
- state: stopped
- status: static
#
Initrd-Parse-Etc.Service
- name: initrd-parse-etc.service
- source: systemd
- state: stopped
- status: static
#
Initrd-Switch-Root.Service
- name: initrd-switch-root.service
- source: systemd
- state: stopped
- status: static
#
Initrd-Udevadm-Cleanup-Db.Service
- name: initrd-udevadm-cleanup-db.service
- source: systemd
- state: stopped
- status: static
#
Iprdump.Service
- name: iprdump.service
- source: systemd
- state: inactive
- status: disabled
#
Iprinit.Service
- name: iprinit.service
- source: systemd
- state: inactive
- status: disabled
#
Iprupdate.Service
- name: iprupdate.service
- source: systemd
- state: inactive
- status: disabled
#
Irqbalance.Service
- name: irqbalance.service
- source: systemd
- state: stopped
- status: enabled
#
Kdump.Service
- name: kdump.service
- source: systemd
- state: stopped
- status: enabled
#
Kmod-Static-Nodes.Service
- name: kmod-static-nodes.service
- source: systemd
- state: stopped
- status: static
#
Ldconfig.Service
- name: ldconfig.service
- source: systemd
- state: stopped
- status: static
#
Loadmodules.Service
- name: loadmodules.service
- source: systemd
- state: stopped
- status: enabled
#
Lvm2-Lvmpolld.Service
- name: lvm2-lvmpolld.service
- source: systemd
- state: stopped
- status: static
#
Lvm2-Monitor.Service
- name: lvm2-monitor.service
- source: systemd
- state: stopped
- status: enabled
Lvm2-Pvscan@.Service#
- name: lvm2-pvscan@.service
- source: systemd
- state: unknown
- status: static
#
Lvm2-Pvscan@8:2.Service
- name: lvm2-pvscan@8:2.service
- source: systemd
- state: stopped
- status: unknown
#
Man-Db-Cache-Update.Service
- name: man-db-cache-update.service
- source: systemd
- state: inactive
- status: static
#
Messagebus.Service
- name: messagebus.service
- source: systemd
- state: active
- status: static
#
Microcode.Service
- name: microcode.service
- source: systemd
- state: stopped
- status: enabled
#
Nftables.Service
- name: nftables.service
- source: systemd
- state: inactive
- status: disabled
#
Nis-Domainname.Service
- name: nis-domainname.service
- source: systemd
- state: stopped
- status: enabled
#
Plymouth-Halt.Service
- name: plymouth-halt.service
- source: systemd
- state: inactive
- status: static
#
Plymouth-Kexec.Service
- name: plymouth-kexec.service
- source: systemd
- state: inactive
- status: static
#
Plymouth-Poweroff.Service
- name: plymouth-poweroff.service
- source: systemd
- state: inactive
- status: static
#
Plymouth-Quit-Wait.Service
- name: plymouth-quit-wait.service
- source: systemd
- state: stopped
- status: static
#
Plymouth-Quit.Service
- name: plymouth-quit.service
- source: systemd
- state: stopped
- status: static
#
Plymouth-Read-Write.Service
- name: plymouth-read-write.service
- source: systemd
- state: stopped
- status: static
#
Plymouth-Reboot.Service
- name: plymouth-reboot.service
- source: systemd
- state: inactive
- status: static
#
Plymouth-Start.Service
- name: plymouth-start.service
- source: systemd
- state: stopped
- status: static
#
Plymouth-Switch-Root.Service
- name: plymouth-switch-root.service
- source: systemd
- state: stopped
- status: static
#
Polkit.Service
- name: polkit.service
- source: systemd
- state: running
- status: static
#
Quotaon.Service
- name: quotaon.service
- source: systemd
- state: inactive
- status: static
#
Rc-Local.Service
- name: rc-local.service
- source: systemd
- state: stopped
- status: static
#
Rdisc.Service
- name: rdisc.service
- source: systemd
- state: inactive
- status: disabled
#
Rescue.Service
- name: rescue.service
- source: systemd
- state: stopped
- status: static
#
Rngd-Wake-Threshold.Service
- name: rngd-wake-threshold.service
- source: systemd
- state: stopped
- status: disabled
#
Rngd.Service
- name: rngd.service
- source: systemd
- state: running
- status: enabled
#
Rsyslog.Service
- name: rsyslog.service
- source: systemd
- state: running
- status: enabled
#
Selinux-Autorelabel-Mark.Service
- name: selinux-autorelabel-mark.service
- source: systemd
- state: stopped
- status: enabled
#
Selinux-Autorelabel.Service
- name: selinux-autorelabel.service
- source: systemd
- state: inactive
- status: static
Serial-Getty@.Service#
- name: serial-getty@.service
- source: systemd
- state: unknown
- status: disabled
Sshd-Keygen@.Service#
- name: sshd-keygen@.service
- source: systemd
- state: unknown
- status: disabled
test1@test.service#
- name: test1@test.service
- source: systemd
- state: stopped
- status: unknown
test2@test.service#
- name: test2@test.service
- source: systemd
- state: stopped
- status: unknown
test3@test.service#
- name: test3@test.service
- source: systemd
- state: stopped
- status: unknown
#
Sshd.Service
- name: sshd.service
- source: systemd
- state: running
- status: enabled
Sshd@.Service#
- name: sshd@.service
- source: systemd
- state: unknown
- status: static
#
Sssd-Autofs.Service
- name: sssd-autofs.service
- source: systemd
- state: inactive
- status: indirect
#
Sssd-Kcm.Service
- name: sssd-kcm.service
- source: systemd
- state: stopped
- status: indirect
#
Sssd-Nss.Service
- name: sssd-nss.service
- source: systemd
- state: inactive
- status: indirect
#
Sssd-Pac.Service
- name: sssd-pac.service
- source: systemd
- state: inactive
- status: indirect
#
Sssd-Pam.Service
- name: sssd-pam.service
- source: systemd
- state: inactive
- status: indirect
#
Sssd-Ssh.Service
- name: sssd-ssh.service
- source: systemd
- state: inactive
- status: indirect
#
Sssd-Sudo.Service
- name: sssd-sudo.service
- source: systemd
- state: inactive
- status: indirect
#
Sssd.Service
- name: sssd.service
- source: systemd
- state: running
- status: enabled
#
Syslog.Service
- name: syslog.service
- source: systemd
- state: active
- status: enabled
#
System-Update-Cleanup.Service
- name: system-update-cleanup.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Ask-Password-Console.Service
- name: systemd-ask-password-console.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Ask-Password-Plymouth.Service
- name: systemd-ask-password-plymouth.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Ask-Password-Wall.Service
- name: systemd-ask-password-wall.service
- source: systemd
- state: stopped
- status: static
Systemd-Backlight@.Service#
- name: systemd-backlight@.service
- source: systemd
- state: unknown
- status: static
#
Systemd-Binfmt.Service
- name: systemd-binfmt.service
- source: systemd
- state: stopped
- status: static
Systemd-Coredump@.Service#
- name: systemd-coredump@.service
- source: systemd
- state: unknown
- status: static
test4@test.service#
- name: test4@test.service
- source: systemd
- state: stopped
- status: unknown
#
Systemd-Exit.Service
- name: systemd-exit.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Firstboot.Service
- name: systemd-firstboot.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Fsck-Root.Service
- name: systemd-fsck-root.service
- source: systemd
- state: stopped
- status: static
Systemd-Fsck@.Service#
- name: systemd-fsck@.service
- source: systemd
- state: unknown
- status: static
#
Systemd-Fsck@Dev-Disk-By\X2Duuid-99851642\X2D260F\X2D4D7E\X2D83Dd\X2D7Cc990D49126.Service
- name: systemd-fsck@dev-disk-by\x2duuid-99851642\x2d260f\x2d4d7e\x2d83dd\x2d7cc990d49126.service
- source: systemd
- state: stopped
- status: unknown
#
Systemd-Halt.Service
- name: systemd-halt.service
- source: systemd
- state: inactive
- status: static
Systemd-Hibernate-Resume@.Service#
- name: systemd-hibernate-resume@.service
- source: systemd
- state: unknown
- status: static
#
Systemd-Hibernate.Service
- name: systemd-hibernate.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Hostnamed.Service
- name: systemd-hostnamed.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Hwdb-Update.Service
- name: systemd-hwdb-update.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Hybrid-Sleep.Service
- name: systemd-hybrid-sleep.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Initctl.Service
- name: systemd-initctl.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Journal-Catalog-Update.Service
- name: systemd-journal-catalog-update.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Journal-Flush.Service
- name: systemd-journal-flush.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Journald.Service
- name: systemd-journald.service
- source: systemd
- state: running
- status: static
#
Systemd-Kexec.Service
- name: systemd-kexec.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Localed.Service
- name: systemd-localed.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Logind.Service
- name: systemd-logind.service
- source: systemd
- state: running
- status: static
#
Systemd-Machine-Id-Commit.Service
- name: systemd-machine-id-commit.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Modules-Load.Service
- name: systemd-modules-load.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Portabled.Service
- name: systemd-portabled.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Poweroff.Service
- name: systemd-poweroff.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Quotacheck.Service
- name: systemd-quotacheck.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Random-Seed.Service
- name: systemd-random-seed.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Reboot.Service
- name: systemd-reboot.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Remount-Fs.Service
- name: systemd-remount-fs.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Resolved.Service
- name: systemd-resolved.service
- source: systemd
- state: inactive
- status: disabled
#
Systemd-Rfkill.Service
- name: systemd-rfkill.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Suspend-Then-Hibernate.Service
- name: systemd-suspend-then-hibernate.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Suspend.Service
- name: systemd-suspend.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Sysctl.Service
- name: systemd-sysctl.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Sysusers.Service
- name: systemd-sysusers.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Timedated.Service
- name: systemd-timedated.service
- source: systemd
- state: inactive
- status: masked
#
Systemd-Tmpfiles-Clean.Service
- name: systemd-tmpfiles-clean.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Tmpfiles-Setup-Dev.Service
- name: systemd-tmpfiles-setup-dev.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Tmpfiles-Setup.Service
- name: systemd-tmpfiles-setup.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Udev-Settle.Service
- name: systemd-udev-settle.service
- source: systemd
- state: inactive
- status: static
#
Systemd-Udev-Trigger.Service
- name: systemd-udev-trigger.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Udevd.Service
- name: systemd-udevd.service
- source: systemd
- state: running
- status: static
#
Systemd-Update-Done.Service
- name: systemd-update-done.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Update-Utmp-Runlevel.Service
- name: systemd-update-utmp-runlevel.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Update-Utmp.Service
- name: systemd-update-utmp.service
- source: systemd
- state: stopped
- status: static
#
Systemd-User-Sessions.Service
- name: systemd-user-sessions.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Vconsole-Setup.Service
- name: systemd-vconsole-setup.service
- source: systemd
- state: stopped
- status: static
#
Systemd-Volatile-Root.Service
- name: systemd-volatile-root.service
- source: systemd
- state: inactive
- status: static
#
Tcsd.Service
- name: tcsd.service
- source: systemd
- state: inactive
- status: disabled
Teamd@.Service#
- name: teamd@.service
- source: systemd
- state: unknown
- status: static
#
Timedatex.Service
- name: timedatex.service
- source: systemd
- state: inactive
- status: enabled
#
Tuned.Service
- name: tuned.service
- source: systemd
- state: running
- status: enabled
#
Unbound-Anchor.Service
- name: unbound-anchor.service
- source: systemd
- state: stopped
- status: static
User-Runtime-Dir@.Service#
- name: user-runtime-dir@.service
- source: systemd
- state: unknown
- status: static
test5@test.service#
- name: test5@test.service
- source: systemd
- state: stopped
- status: unknown
User@.Service#
- name: user@.service
- source: systemd
- state: unknown
- status: static
test6@test.service#
- name: test6@test.service
- source: systemd
- state: running
- status: unknown
#
Vgauthd.Service
- name: vgauthd.service
- source: systemd
- state: running
- status: enabled
#
Vmtoolsd.Service
- name: vmtoolsd.service
- source: systemd
- state: running
- status: enabled
#
linux-setupGathers facts about remote hosts Further documentation available at https://docs.ansible.com/ansible/2.9/modules/setup_module.html
#
Base Commandlinux-setup
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
gather_subset | If supplied, restrict the additional facts collected to the given subset. Possible values: all , min , hardware , network , virtual , ohai , and facter . Can specify a list of values to specify a larger subset. Values can also be used with an initial ! to specify that that specific subset should not be collected. For instance: !hardware,!network,!virtual,!ohai,!facter . If !all is specified then only the min subset is collected. To avoid collecting even the min subset, specify !all,!min . To collect only specific facts, use !all,!min , and specify the particular fact subsets. Use the filter parameter if you do not want to display some collected facts. Default is all. | Optional |
gather_timeout | Set the default timeout in seconds for individual fact gathering. Default is 10. | Optional |
filter | If supplied, only return facts that match this shell-style (fnmatch) wildcard. Default is *. | Optional |
fact_path | Path used for local ansible facts (*.fact ) - files in this dir will be run (if executable) and their results be added to local facts if a file is not executable it is read. Check notes for Windows options. (from 2.1 on) File/results format can be JSON or INI-format. The default fact_path can be specified in ansible.cfg for when setup is automatically called as part of gather_facts . Default is /etc/ansible/facts.d. | Optional |
#
Context OutputPath | Type | Description |
---|
#
linux-sysctlManage entries in sysctl.conf. Further documentation available at https://docs.ansible.com/ansible/2.9/modules/sysctl_module.html
#
Base Commandlinux-sysctl
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | The dot-separated path (aka key ) specifying the sysctl variable. | Required |
value | Desired value of the sysctl key. | Optional |
state | Whether the entry should be present or absent in the sysctl file. Possible values are: present, absent. Default is present. | Optional |
ignoreerrors | Use this option to ignore errors about unknown keys. Default is no. | Optional |
reload | If yes , performs a /sbin/sysctl -p if the sysctl_file is updated. If no , does not reload sysctl even if the sysctl_file is updated. Default is yes. | Optional |
sysctl_file | Specifies the absolute path to sysctl.conf , if not /etc/sysctl.conf . Default is /etc/sysctl.conf. | Optional |
sysctl_set | Verify token value with the sysctl command and set with -w if necessary. Default is no. | Optional |
#
Context OutputPath | Type | Description |
---|
#
Command Example!linux-sysctl host="123.123.123.123" name="vm.swappiness" value="5" state="present"
#
Context Example#
Human Readable Output#
123.123.123.123 - SUCCESS
- changed: False
#
linux-systemdManage services Further documentation available at https://docs.ansible.com/ansible/2.9/modules/systemd_module.html
#
Base Commandlinux-systemd
#
InputArgument Name | Description | Required |
---|---|---|
host | hostname or IP of target. Optionally the port can be specified using :PORT. If multiple targets are specified using an array, the integration will use the configured concurrency factor for high performance. | Required |
name | Name of the service. This parameter takes the name of exactly one service to work with. When using in a chroot environment you always need to specify the full name i.e. (crond.service). | Optional |
state | started /stopped are idempotent actions that will not run commands unless necessary. restarted will always bounce the service. reloaded will always reload. Possible values are: reloaded, restarted, started, stopped. | Optional |
enabled | Whether the service should start on boot. At least one of state and enabled are required. . | Optional |
force | Whether to override existing symlinks. | Optional |
masked | Whether the unit should be masked or not, a masked unit is impossible to start. | Optional |
daemon_reload | Run daemon-reload before doing any other operations, to make sure systemd has read any changes. When set to yes , runs daemon-reload even if the module does not start or stop anything. Possible values are: Yes, No. Default is No. | Optional |
daemon_reexec | Run daemon_reexec command before doing any other operations, the systemd manager will serialize the manager state. Possible values are: Yes, No. Default is No. | Optional |
user | (deprecated) run systemctl talking to the service manager of the calling user, rather than the service manager of the system.This option is deprecated and will eventually be removed in 2.11. The scope option should be used instead. Possible values are: Yes, No. Default is No. | Optional |
scope | run systemctl within a given service manager scope, either as the default system scope (system), the current user's scope (user), or the scope of all users (global). For systemd to work with 'user', the executing user must have its own instance of dbus started (systemd requirement). The user dbus process is normally started during normal login, but not during the run of Ansible tasks. Otherwise you will probably get a 'Failed to connect to bus: no such file or directory' error. Possible values are: system, user, global. | Optional |
no_block | Do not synchronously wait for the requested operation to finish. Enqueued job will continue without Ansible blocking on its completion. Possible values are: Yes, No. Default is No. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Linux.Systemd.status | unknown | A dictionary with the key=value pairs returned from `systemctl show` |
#
Command Example!linux-systemd host="123.123.123.123" state="started" name="httpd"