` for details.
+
+ To use it in a playbook, specify: :code:`redhat.satellite.host`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in redhat.satellite 1.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Create, update, and delete Hosts
+
+
+.. Aliases
+
+Aliases: foreman_host
+
+.. Requirements
+
+.. _ansible_collections.redhat.satellite.host_module_requirements:
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- requests
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-activation_keys:
+
+ .. rst-class:: ansible-option-title
+
+ **activation_keys**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Activation Keys used for deployment.
+
+ Comma separated list.
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-architecture:
+
+ .. rst-class:: ansible-option-title
+
+ **architecture**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Architecture name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-build:
+
+ .. rst-class:: ansible-option-title
+
+ **build**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to setup build context for the host
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-comment:
+
+ .. rst-class:: ansible-option-title
+
+ **comment**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Comment about the host.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-compute_attributes:
+
+ .. rst-class:: ansible-option-title
+
+ **compute_attributes**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Additional compute resource specific attributes.
+
+ When this parameter is set, the module will not be idempotent.
+
+ When you provide a \ :emphasis:`cluster`\ here and \ :emphasis:`compute\_resource`\ is set, the cluster id will be automatically looked up.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-compute_profile:
+
+ .. rst-class:: ansible-option-title
+
+ **compute_profile**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Compute profile name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-compute_resource:
+
+ .. rst-class:: ansible-option-title
+
+ **compute_resource**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Compute resource name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-config_groups:
+
+ .. rst-class:: ansible-option-title
+
+ **config_groups**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ Config groups list
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-content_source:
+
+ .. rst-class:: ansible-option-title
+
+ **content_source**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Content Source (Smart Proxy with Content) name.
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-content_view:
+
+ .. rst-class:: ansible-option-title
+
+ **content_view**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Content view.
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-domain:
+
+ .. rst-class:: ansible-option-title
+
+ **domain**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Domain name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-enabled:
+
+ .. rst-class:: ansible-option-title
+
+ **enabled**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Include this host within reporting
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-environment:
+
+ .. rst-class:: ansible-option-title
+
+ **environment**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Puppet environment name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-hostgroup:
+
+ .. rst-class:: ansible-option-title
+
+ **hostgroup**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Title of related hostgroup
+
+ Example: A child hostgroup \ :emphasis:`bar`\ within a parent hostgroup \ :emphasis:`foo`\ would have the title \ :emphasis:`foo/bar`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-image:
+
+ .. rst-class:: ansible-option-title
+
+ **image**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The image to use when \ :emphasis:`provision\_method=image`\ .
+
+ The \ :emphasis:`compute\_resource`\ parameter is required to find the correct image.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes:
+
+ .. rst-class:: ansible-option-title
+
+ **interfaces_attributes**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ :ansible-option-versionadded:`added in redhat.satellite 1.5.0`
+
+
+ .. raw:: html
+
+
+
+ Additional interfaces specific attributes.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/attached_devices:
+
+ .. rst-class:: ansible-option-title
+
+ **attached_devices**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ Identifiers of attached interfaces, e.g. ['eth1', 'eth2'].
+
+ For bond interfaces those are the slaves.
+
+ Only for bond and bridges interfaces.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/attached_to:
+
+ .. rst-class:: ansible-option-title
+
+ **attached_to**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Identifier of the interface to which this interface belongs, e.g. eth1.
+
+ Only for virtual interfaces.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/bond_options:
+
+ .. rst-class:: ansible-option-title
+
+ **bond_options**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Space separated options, e.g. miimon=100.
+
+ Only for bond interfaces.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/compute_attributes:
+
+ .. rst-class:: ansible-option-title
+
+ **compute_attributes**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Additional compute resource specific attributes for the interface.
+
+ When this parameter is set, the module will not be idempotent.
+
+ When you provide a \ :emphasis:`network`\ here and \ :emphasis:`compute\_resource`\ is set, the network id will be automatically looked up.
+
+ On oVirt/RHV \ :emphasis:`cluster`\ is required in the hosts \ :emphasis:`compute\_attributes`\ for the lookup to work.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/domain:
+
+ .. rst-class:: ansible-option-title
+
+ **domain**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Domain name
+
+ Required for primary interfaces on managed hosts.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/execution:
+
+ .. rst-class:: ansible-option-title
+
+ **execution**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Should this interface be used for Remote Execution?
+
+ Each managed hosts should have one remote execution interface.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/identifier:
+
+ .. rst-class:: ansible-option-title
+
+ **identifier**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Device identifier, e.g. eth0 or eth1.1
+
+ You need to set one of \ :emphasis:`identifier`\ , \ :emphasis:`name`\ or \ :emphasis:`mac`\ to be able to update existing interfaces and make execution idempotent.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/ip:
+
+ .. rst-class:: ansible-option-title
+
+ **ip**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IPv4 address of interface
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/ip6:
+
+ .. rst-class:: ansible-option-title
+
+ **ip6**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IPv6 address of interface
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/mac:
+
+ .. rst-class:: ansible-option-title
+
+ **mac**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ MAC address of interface. Required for managed interfaces on bare metal.
+
+ Please include leading zeros and separate nibbles by colons, otherwise the execution will not be idempotent.
+
+ Example EE:BB:01:02:03:04
+
+ You need to set one of \ :emphasis:`identifier`\ , \ :emphasis:`name`\ or \ :emphasis:`mac`\ to be able to update existing interfaces and make execution idempotent.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/managed:
+
+ .. rst-class:: ansible-option-title
+
+ **managed**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Should this interface be managed via DHCP and DNS smart proxy and should it be configured during provisioning?
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/mode:
+
+ .. rst-class:: ansible-option-title
+
+ **mode**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Bond mode of the interface.
+
+ Only for bond interfaces.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"balance-rr"`
+ - :ansible-option-choices-entry:`"active-backup"`
+ - :ansible-option-choices-entry:`"balance-xor"`
+ - :ansible-option-choices-entry:`"broadcast"`
+ - :ansible-option-choices-entry:`"802.3ad"`
+ - :ansible-option-choices-entry:`"balance-tlb"`
+ - :ansible-option-choices-entry:`"balance-alb"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/mtu:
+
+ .. rst-class:: ansible-option-title
+
+ **mtu**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`integer`
+
+ .. raw:: html
+
+
+
+ MTU, this attribute has precedence over the subnet MTU.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Interface's DNS name
+
+ You need to set one of \ :emphasis:`identifier`\ , \ :emphasis:`name`\ or \ :emphasis:`mac`\ to be able to update existing interfaces and make execution idempotent.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/password:
+
+ .. rst-class:: ansible-option-title
+
+ **password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Password for BMC authentication.
+
+ Only for BMC interfaces.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/primary:
+
+ .. rst-class:: ansible-option-title
+
+ **primary**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Should this interface be used for constructing the FQDN of the host?
+
+ Each managed hosts needs to have one primary interface.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/provider:
+
+ .. rst-class:: ansible-option-title
+
+ **provider**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Interface provider, e.g. IPMI.
+
+ Only for BMC interfaces.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"IPMI"`
+ - :ansible-option-choices-entry:`"Redfish"`
+ - :ansible-option-choices-entry:`"SSH"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/provision:
+
+ .. rst-class:: ansible-option-title
+
+ **provision**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Should this interface be used for TFTP of PXELinux (or SSH for image-based hosts)?
+
+ Each managed hosts needs to have one provision interface.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/subnet:
+
+ .. rst-class:: ansible-option-title
+
+ **subnet**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IPv4 Subnet name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/subnet6:
+
+ .. rst-class:: ansible-option-title
+
+ **subnet6**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IPv6 Subnet name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/tag:
+
+ .. rst-class:: ansible-option-title
+
+ **tag**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ VLAN tag, this attribute has precedence over the subnet VLAN ID.
+
+ Only for virtual interfaces.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/type:
+
+ .. rst-class:: ansible-option-title
+
+ **type**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Interface type.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"interface"`
+ - :ansible-option-choices-entry:`"bmc"`
+ - :ansible-option-choices-entry:`"bond"`
+ - :ansible-option-choices-entry:`"bridge"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/username:
+
+ .. rst-class:: ansible-option-title
+
+ **username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Username for BMC authentication.
+
+ Only for BMC interfaces.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-interfaces_attributes/virtual:
+
+ .. rst-class:: ansible-option-title
+
+ **virtual**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Alias or VLAN device
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-ip:
+
+ .. rst-class:: ansible-option-title
+
+ **ip**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IP address of the primary interface of the host.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-kickstart_repository:
+
+ .. rst-class:: ansible-option-title
+
+ **kickstart_repository**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Kickstart repository name.
+
+ You need to provide this to use the "Synced Content" feature.
+
+ Mutually exclusive with \ :emphasis:`medium`\ .
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-lifecycle_environment:
+
+ .. rst-class:: ansible-option-title
+
+ **lifecycle_environment**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Lifecycle environment.
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-location:
+
+ .. rst-class:: ansible-option-title
+
+ **location**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of related location
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-mac:
+
+ .. rst-class:: ansible-option-title
+
+ **mac**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ MAC address of the primary interface of the host.
+
+ Please include leading zeros and separate nibbles by colons, otherwise the execution will not be idempotent.
+
+ Example EE:BB:01:02:03:04
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-managed:
+
+ .. rst-class:: ansible-option-title
+
+ **managed**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether a host is managed or unmanaged.
+
+ Forced to true when \ :emphasis:`build=true`\
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-media:
+ .. _ansible_collections.redhat.satellite.host_module__parameter-medium:
+
+ .. rst-class:: ansible-option-title
+
+ **medium**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: media`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Medium name
+
+ Mutually exclusive with \ :emphasis:`kickstart\_repository`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Fully Qualified Domain Name of host
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-openscap_proxy:
+
+ .. rst-class:: ansible-option-title
+
+ **openscap_proxy**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ OpenSCAP proxy name.
+
+ Only available when the OpenSCAP plugin is installed.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-operatingsystem:
+
+ .. rst-class:: ansible-option-title
+
+ **operatingsystem**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Operating systems are looked up by their title which is composed as "\ \.\".
+
+ You can omit the version part as long as you only have one operating system by that name.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-organization:
+
+ .. rst-class:: ansible-option-title
+
+ **organization**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of related organization
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-owner:
+
+ .. rst-class:: ansible-option-title
+
+ **owner**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Owner (user) of the host.
+
+ Users are looked up by their \ :literal:`login`\ .
+
+ Mutually exclusive with \ :emphasis:`owner\_group`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-owner_group:
+
+ .. rst-class:: ansible-option-title
+
+ **owner_group**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Owner (user group) of the host.
+
+ Mutually exclusive with \ :emphasis:`owner`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-parameters:
+
+ .. rst-class:: ansible-option-title
+
+ **parameters**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ Entity domain specific host parameters
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-parameters/name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Name of the parameter
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-parameters/parameter_type:
+
+ .. rst-class:: ansible-option-title
+
+ **parameter_type**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Type of the parameter
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"string"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"boolean"`
+ - :ansible-option-choices-entry:`"integer"`
+ - :ansible-option-choices-entry:`"real"`
+ - :ansible-option-choices-entry:`"array"`
+ - :ansible-option-choices-entry:`"hash"`
+ - :ansible-option-choices-entry:`"yaml"`
+ - :ansible-option-choices-entry:`"json"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-parameters/value:
+
+ .. rst-class:: ansible-option-title
+
+ **value**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`any` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Value of the parameter
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Password of the user accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-provision_method:
+
+ .. rst-class:: ansible-option-title
+
+ **provision_method**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ The method used to provision the host.
+
+ \ :emphasis:`provision\_method=bootdisk`\ is only available if the bootdisk plugin is installed.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"build"`
+ - :ansible-option-choices-entry:`"image"`
+ - :ansible-option-choices-entry:`"bootdisk"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-ptable:
+
+ .. rst-class:: ansible-option-title
+
+ **ptable**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Partition table name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-puppet_ca_proxy:
+
+ .. rst-class:: ansible-option-title
+
+ **puppet_ca_proxy**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Puppet CA proxy name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-puppet_proxy:
+
+ .. rst-class:: ansible-option-title
+
+ **puppet_proxy**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Puppet server proxy name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-puppetclasses:
+
+ .. rst-class:: ansible-option-title
+
+ **puppetclasses**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of puppet classes to include in this host group. Must exist for hostgroup's puppet environment.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-pxe_loader:
+
+ .. rst-class:: ansible-option-title
+
+ **pxe_loader**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ PXE Bootloader
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"PXELinux BIOS"`
+ - :ansible-option-choices-entry:`"PXELinux UEFI"`
+ - :ansible-option-choices-entry:`"Grub UEFI"`
+ - :ansible-option-choices-entry:`"Grub2 BIOS"`
+ - :ansible-option-choices-entry:`"Grub2 ELF"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI SecureBoot"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI HTTP"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI HTTPS"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI HTTPS SecureBoot"`
+ - :ansible-option-choices-entry:`"iPXE Embedded"`
+ - :ansible-option-choices-entry:`"iPXE UEFI HTTP"`
+ - :ansible-option-choices-entry:`"iPXE Chain BIOS"`
+ - :ansible-option-choices-entry:`"iPXE Chain UEFI"`
+ - :ansible-option-choices-entry:`"None"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-realm:
+
+ .. rst-class:: ansible-option-title
+
+ **realm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Realm name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-root_pass:
+
+ .. rst-class:: ansible-option-title
+
+ **root_pass**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Root password.
+
+ Will result in the entity always being updated, as the current password cannot be retrieved.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-server_url:
+
+ .. rst-class:: ansible-option-title
+
+ **server_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ State of the entity
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-subnet:
+
+ .. rst-class:: ansible-option-title
+
+ **subnet**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IPv4 Subnet name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-subnet6:
+
+ .. rst-class:: ansible-option-title
+
+ **subnet6**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IPv6 Subnet name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Username accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to verify the TLS certificates of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\ will be used instead.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in check\_mode and return changed status prediction without modifying the entity
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in check\_mode), when in diff mode
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: "Create a host"
+ redhat.satellite.host:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "new_host"
+ hostgroup: my_hostgroup
+ state: present
+
+ - name: "Create a host with build context"
+ redhat.satellite.host:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "new_host"
+ hostgroup: my_hostgroup
+ build: true
+ state: present
+
+ - name: "Create an unmanaged host"
+ redhat.satellite.host:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "new_host"
+ managed: false
+ state: present
+
+ - name: "Create a VM with 2 CPUs and 4GB RAM"
+ redhat.satellite.host:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "new_host"
+ compute_attributes:
+ cpus: 2
+ memory_mb: 4096
+ state: present
+
+ - name: "Create a VM and start it after creation"
+ redhat.satellite.host:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "new_host"
+ compute_attributes:
+ start: "1"
+ state: present
+
+ - name: "Create a VM on specific ovirt network"
+ redhat.satellite.host:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "new_host"
+ interfaces_attributes:
+ - type: "interface"
+ compute_attributes:
+ name: "nic1"
+ network: "969efbe6-f9e0-4383-a19a-a7ee65ad5007"
+ interface: "virtio"
+ state: present
+
+ - name: "Create a VM with 2 NICs on specific ovirt networks"
+ redhat.satellite.host:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "new_host"
+ interfaces_attributes:
+ - type: "interface"
+ primary: true
+ compute_attributes:
+ name: "nic1"
+ network: "969efbe6-f9e0-4383-a19a-a7ee65ad5007"
+ interface: "virtio"
+ - type: "interface"
+ name: "new_host_nic2"
+ managed: true
+ compute_attributes:
+ name: "nic2"
+ network: "969efbe6-f9e0-4383-a19a-a7ee65ad5008"
+ interface: "e1000"
+ state: present
+
+ - name: "Delete a host"
+ redhat.satellite.host:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "new_host"
+ state: absent
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__return-entity:
+
+ .. rst-class:: ansible-option-title
+
+ **entity**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Final state of the affected entities grouped by their type.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_module__return-entity/hosts:
+
+ .. rst-class:: ansible-option-title
+
+ **hosts**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ List of hosts.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+
+ .. raw:: html
+
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Bernhard Hopfenmueller (@Fobhep) ATIX AG
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. raw:: html
+
+
+ Issue Tracker
+ Homepage
+ Repository (Sources)
+
+
+.. Parsing errors
+
diff --git a/3.11.0/_sources/plugins/host_power_module.rst.txt b/3.11.0/_sources/plugins/host_power_module.rst.txt
new file mode 100644
index 00000000..0dc762af
--- /dev/null
+++ b/3.11.0/_sources/plugins/host_power_module.rst.txt
@@ -0,0 +1,588 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. role:: ansible-attribute-support-label
+.. role:: ansible-attribute-support-property
+.. role:: ansible-attribute-support-full
+.. role:: ansible-attribute-support-partial
+.. role:: ansible-attribute-support-none
+.. role:: ansible-attribute-support-na
+.. role:: ansible-option-type
+.. role:: ansible-option-elements
+.. role:: ansible-option-required
+.. role:: ansible-option-versionadded
+.. role:: ansible-option-aliases
+.. role:: ansible-option-choices
+.. role:: ansible-option-choices-default-mark
+.. role:: ansible-option-default-bold
+.. role:: ansible-option-configuration
+.. role:: ansible-option-returned-bold
+.. role:: ansible-option-sample-bold
+
+.. Anchors
+
+.. _ansible_collections.redhat.satellite.host_power_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+redhat.satellite.host_power module -- Manage Power State of Hosts
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `redhat.satellite collection `_ (version 3.11.0).
+
+ To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
+ You need further requirements to be able to use this module,
+ see :ref:`Requirements ` for details.
+
+ To use it in a playbook, specify: :code:`redhat.satellite.host_power`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in redhat.satellite 1.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Manage power state of a host
+- This beta version can start and stop an existing foreman host and question the current power state.
+
+
+.. Aliases
+
+Aliases: foreman_host_power
+
+.. Requirements
+
+.. _ansible_collections.redhat.satellite.host_power_module_requirements:
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- requests
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__parameter-hostname:
+ .. _ansible_collections.redhat.satellite.host_power_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: hostname`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Name (FQDN) of the host
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Password of the user accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__parameter-server_url:
+
+ .. rst-class:: ansible-option-title
+
+ **server_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Desired power state
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"on"`
+ - :ansible-option-choices-entry:`"start"`
+ - :ansible-option-choices-entry:`"off"`
+ - :ansible-option-choices-entry:`"stop"`
+ - :ansible-option-choices-entry:`"soft"`
+ - :ansible-option-choices-entry:`"reboot"`
+ - :ansible-option-choices-entry:`"cycle"`
+ - :ansible-option-choices-entry:`"reset"`
+ - :ansible-option-choices-entry-default:`"state"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"status"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Username accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to verify the TLS certificates of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\ will be used instead.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in check\_mode and return changed status prediction without modifying the entity
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in check\_mode), when in diff mode
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: "Switch a host on"
+ redhat.satellite.host_power:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ hostname: "test-host.domain.test"
+ state: on
+
+ - name: "Switch a host off"
+ redhat.satellite.host_power:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ hostname: "test-host.domain.test"
+ state: off
+
+ - name: "Query host power state"
+ redhat.satellite.host_power:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ hostname: "test-host.domain.test"
+ state: state
+ register: result
+ - debug:
+ msg: "Host power state is {{ result.power_state }}"
+
+
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.host_power_module__return-power_state:
+
+ .. rst-class:: ansible-option-title
+
+ **power_state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ current power state of host
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` always
+
+ .. rst-class:: ansible-option-line
+ .. rst-class:: ansible-option-sample
+
+ :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"off"`
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Bernhard Hopfenmueller (@Fobhep) ATIX AG
+- Baptiste Agasse (@bagasse)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. raw:: html
+
+
+ Issue Tracker
+ Homepage
+ Repository (Sources)
+
+
+.. Parsing errors
+
diff --git a/3.11.0/_sources/plugins/hostgroup_info_module.rst.txt b/3.11.0/_sources/plugins/hostgroup_info_module.rst.txt
new file mode 100644
index 00000000..38be4bef
--- /dev/null
+++ b/3.11.0/_sources/plugins/hostgroup_info_module.rst.txt
@@ -0,0 +1,657 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. role:: ansible-attribute-support-label
+.. role:: ansible-attribute-support-property
+.. role:: ansible-attribute-support-full
+.. role:: ansible-attribute-support-partial
+.. role:: ansible-attribute-support-none
+.. role:: ansible-attribute-support-na
+.. role:: ansible-option-type
+.. role:: ansible-option-elements
+.. role:: ansible-option-required
+.. role:: ansible-option-versionadded
+.. role:: ansible-option-aliases
+.. role:: ansible-option-choices
+.. role:: ansible-option-choices-default-mark
+.. role:: ansible-option-default-bold
+.. role:: ansible-option-configuration
+.. role:: ansible-option-returned-bold
+.. role:: ansible-option-sample-bold
+
+.. Anchors
+
+.. _ansible_collections.redhat.satellite.hostgroup_info_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+redhat.satellite.hostgroup_info module -- Get information about hostgroup(s)
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `redhat.satellite collection `_ (version 3.11.0).
+
+ To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
+ You need further requirements to be able to use this module,
+ see :ref:`Requirements ` for details.
+
+ To use it in a playbook, specify: :code:`redhat.satellite.hostgroup_info`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in redhat.satellite 3.9.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Get information about hostgroup(s)
+
+
+.. Aliases
+
+
+.. Requirements
+
+.. _ansible_collections.redhat.satellite.hostgroup_info_module_requirements:
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- requests
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__parameter-location:
+
+ .. rst-class:: ansible-option-title
+
+ **location**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Label of the Location to scope the search for.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of the resource to fetch information for.
+
+ Mutually exclusive with \ :emphasis:`search`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__parameter-organization:
+
+ .. rst-class:: ansible-option-title
+
+ **organization**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Name of the Organization to scope the search for.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Password of the user accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__parameter-search:
+
+ .. rst-class:: ansible-option-title
+
+ **search**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Search query to use
+
+ If None, and \ :emphasis:`name`\ is not set, all resources are returned.
+
+ Mutually exclusive with \ :emphasis:`name`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__parameter-server_url:
+
+ .. rst-class:: ansible-option-title
+
+ **server_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Username accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to verify the TLS certificates of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\ will be used instead.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in check\_mode and return changed status prediction without modifying the entity
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in check\_mode), when in diff mode
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: "Show a hostgroup"
+ redhat.satellite.hostgroup_info:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ name: "Default Hostgroup"
+
+ - name: "Show all hostgroups with 'name ~ Default'"
+ redhat.satellite.hostgroup_info:
+ username: "admin"
+ password: "changeme"
+ server_url: "https://satellite.example.com"
+ search: "name ~ Default"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__return-hostgroup:
+
+ .. rst-class:: ansible-option-title
+
+ **hostgroup**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Details about the found hostgroup
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success and \ :emphasis:`name`\ was passed
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_info_module__return-hostgroups:
+
+ .. rst-class:: ansible-option-title
+
+ **hostgroups**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ List of all found hostgroups and their details
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success and \ :emphasis:`search`\ was passed
+
+
+ .. raw:: html
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Louis Tiches (@TheRedGreek)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. raw:: html
+
+
+ Issue Tracker
+ Homepage
+ Repository (Sources)
+
+
+.. Parsing errors
+
diff --git a/3.11.0/_sources/plugins/hostgroup_module.rst.txt b/3.11.0/_sources/plugins/hostgroup_module.rst.txt
new file mode 100644
index 00000000..bb5bc8a5
--- /dev/null
+++ b/3.11.0/_sources/plugins/hostgroup_module.rst.txt
@@ -0,0 +1,1875 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. role:: ansible-attribute-support-label
+.. role:: ansible-attribute-support-property
+.. role:: ansible-attribute-support-full
+.. role:: ansible-attribute-support-partial
+.. role:: ansible-attribute-support-none
+.. role:: ansible-attribute-support-na
+.. role:: ansible-option-type
+.. role:: ansible-option-elements
+.. role:: ansible-option-required
+.. role:: ansible-option-versionadded
+.. role:: ansible-option-aliases
+.. role:: ansible-option-choices
+.. role:: ansible-option-choices-default-mark
+.. role:: ansible-option-default-bold
+.. role:: ansible-option-configuration
+.. role:: ansible-option-returned-bold
+.. role:: ansible-option-sample-bold
+
+.. Anchors
+
+.. _ansible_collections.redhat.satellite.hostgroup_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+redhat.satellite.hostgroup module -- Manage Hostgroups
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `redhat.satellite collection `_ (version 3.11.0).
+
+ To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
+ You need further requirements to be able to use this module,
+ see :ref:`Requirements ` for details.
+
+ To use it in a playbook, specify: :code:`redhat.satellite.hostgroup`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in redhat.satellite 1.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Create, update, and delete Hostgroups
+
+
+.. Aliases
+
+Aliases: foreman_hostgroup
+
+.. Requirements
+
+.. _ansible_collections.redhat.satellite.hostgroup_module_requirements:
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- requests
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-activation_keys:
+
+ .. rst-class:: ansible-option-title
+
+ **activation_keys**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Activation Keys used for deployment.
+
+ Comma separated list.
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-ansible_roles:
+
+ .. rst-class:: ansible-option-title
+
+ **ansible_roles**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ :ansible-option-versionadded:`added in redhat.satellite 2.1.0`
+
+
+ .. raw:: html
+
+
+
+ A list of ansible roles to associate with the hostgroup.
+
+ The foreman-ansible plugin must be installed to use this parameter.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-architecture:
+
+ .. rst-class:: ansible-option-title
+
+ **architecture**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Architecture name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-compute_profile:
+
+ .. rst-class:: ansible-option-title
+
+ **compute_profile**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Compute profile name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-compute_resource:
+
+ .. rst-class:: ansible-option-title
+
+ **compute_resource**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Compute resource name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-config_groups:
+
+ .. rst-class:: ansible-option-title
+
+ **config_groups**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ Config groups list
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-content_source:
+
+ .. rst-class:: ansible-option-title
+
+ **content_source**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Content Source (Smart Proxy with Content) name.
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-content_view:
+
+ .. rst-class:: ansible-option-title
+
+ **content_view**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Content view.
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-description:
+
+ .. rst-class:: ansible-option-title
+
+ **description**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Description of hostgroup
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-domain:
+
+ .. rst-class:: ansible-option-title
+
+ **domain**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Domain name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-environment:
+
+ .. rst-class:: ansible-option-title
+
+ **environment**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Puppet environment name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-kickstart_repository:
+
+ .. rst-class:: ansible-option-title
+
+ **kickstart_repository**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Kickstart repository name.
+
+ You need to provide this to use the "Synced Content" feature.
+
+ Mutually exclusive with \ :emphasis:`medium`\ .
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-lifecycle_environment:
+
+ .. rst-class:: ansible-option-title
+
+ **lifecycle_environment**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Lifecycle environment.
+
+ Only available for Katello installations.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-locations:
+
+ .. rst-class:: ansible-option-title
+
+ **locations**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of locations the entity should be assigned to
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-media:
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-medium:
+
+ .. rst-class:: ansible-option-title
+
+ **medium**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: media`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Medium name
+
+ Mutually exclusive with \ :emphasis:`kickstart\_repository`\ .
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Name of hostgroup
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-openscap_proxy:
+
+ .. rst-class:: ansible-option-title
+
+ **openscap_proxy**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ OpenSCAP proxy name.
+
+ Only available when the OpenSCAP plugin is installed.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-operatingsystem:
+
+ .. rst-class:: ansible-option-title
+
+ **operatingsystem**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Operating systems are looked up by their title which is composed as "\ \.\".
+
+ You can omit the version part as long as you only have one operating system by that name.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-organization:
+
+ .. rst-class:: ansible-option-title
+
+ **organization**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Organization for scoped resources attached to the hostgroup.
+
+ Only used for Katello installations.
+
+ This organization will implicitly be added to the \ :emphasis:`organizations`\ parameter if needed.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-organizations:
+
+ .. rst-class:: ansible-option-title
+
+ **organizations**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of organizations the entity should be assigned to
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-parameters:
+
+ .. rst-class:: ansible-option-title
+
+ **parameters**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ Hostgroup specific host parameters
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-parameters/name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Name of the parameter
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-parameters/parameter_type:
+
+ .. rst-class:: ansible-option-title
+
+ **parameter_type**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Type of the parameter
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"string"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"boolean"`
+ - :ansible-option-choices-entry:`"integer"`
+ - :ansible-option-choices-entry:`"real"`
+ - :ansible-option-choices-entry:`"array"`
+ - :ansible-option-choices-entry:`"hash"`
+ - :ansible-option-choices-entry:`"yaml"`
+ - :ansible-option-choices-entry:`"json"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-parameters/value:
+
+ .. rst-class:: ansible-option-title
+
+ **value**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`any` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Value of the parameter
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-parent:
+
+ .. rst-class:: ansible-option-title
+
+ **parent**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Hostgroup parent name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Password of the user accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-ptable:
+
+ .. rst-class:: ansible-option-title
+
+ **ptable**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Partition table name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-puppet_ca_proxy:
+
+ .. rst-class:: ansible-option-title
+
+ **puppet_ca_proxy**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Puppet CA proxy name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-puppet_proxy:
+
+ .. rst-class:: ansible-option-title
+
+ **puppet_proxy**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Puppet server proxy name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-puppetclasses:
+
+ .. rst-class:: ansible-option-title
+
+ **puppetclasses**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of puppet classes to include in this host group. Must exist for hostgroup's puppet environment.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-pxe_loader:
+
+ .. rst-class:: ansible-option-title
+
+ **pxe_loader**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ PXE Bootloader
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`"PXELinux BIOS"`
+ - :ansible-option-choices-entry:`"PXELinux UEFI"`
+ - :ansible-option-choices-entry:`"Grub UEFI"`
+ - :ansible-option-choices-entry:`"Grub2 BIOS"`
+ - :ansible-option-choices-entry:`"Grub2 ELF"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI SecureBoot"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI HTTP"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI HTTPS"`
+ - :ansible-option-choices-entry:`"Grub2 UEFI HTTPS SecureBoot"`
+ - :ansible-option-choices-entry:`"iPXE Embedded"`
+ - :ansible-option-choices-entry:`"iPXE UEFI HTTP"`
+ - :ansible-option-choices-entry:`"iPXE Chain BIOS"`
+ - :ansible-option-choices-entry:`"iPXE Chain UEFI"`
+ - :ansible-option-choices-entry:`"None"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-realm:
+
+ .. rst-class:: ansible-option-title
+
+ **realm**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Realm name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-root_pass:
+
+ .. rst-class:: ansible-option-title
+
+ **root_pass**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Root password.
+
+ Will result in the entity always being updated, as the current password cannot be retrieved.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-server_url:
+
+ .. rst-class:: ansible-option-title
+
+ **server_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ State of the entity
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-subnet:
+
+ .. rst-class:: ansible-option-title
+
+ **subnet**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IPv4 Subnet name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-subnet6:
+
+ .. rst-class:: ansible-option-title
+
+ **subnet6**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ IPv6 Subnet name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-updated_name:
+
+ .. rst-class:: ansible-option-title
+
+ **updated_name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ New name of hostgroup. When this parameter is set, the module will not be idempotent.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Username accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to verify the TLS certificates of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\ will be used instead.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in check\_mode and return changed status prediction without modifying the entity
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in check\_mode), when in diff mode
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: "Create a Hostgroup"
+ redhat.satellite.hostgroup:
+ name: "new_hostgroup"
+ architecture: "architecture_name"
+ operatingsystem: "operatingsystem_name"
+ medium: "media_name"
+ ptable: "Partition_table_name"
+ server_url: "https://satellite.example.com"
+ username: "admin"
+ password: "changeme"
+ state: present
+
+ - name: "Update a Hostgroup"
+ redhat.satellite.hostgroup:
+ name: "new_hostgroup"
+ architecture: "updated_architecture_name"
+ operatingsystem: "updated_operatingsystem_name"
+ organizations:
+ - Org One
+ - Org Two
+ locations:
+ - Loc One
+ - Loc Two
+ - Loc One/Nested loc
+ medium: "updated_media_name"
+ ptable: "updated_Partition_table_name"
+ root_pass: "password"
+ server_url: "https://satellite.example.com"
+ username: "admin"
+ password: "changeme"
+ state: present
+
+ - name: "My nested hostgroup"
+ redhat.satellite.hostgroup:
+ parent: "new_hostgroup"
+ name: "my nested hostgroup"
+
+ - name: "My hostgroup with some proxies"
+ redhat.satellite.hostgroup:
+ name: "my hostgroup"
+ environment: production
+ puppet_proxy: puppet-proxy.example.com
+ puppet_ca_proxy: puppet-proxy.example.com
+ openscap_proxy: openscap-proxy.example.com
+
+ - name: "My katello related hostgroup"
+ redhat.satellite.hostgroup:
+ organization: "My Org"
+ name: "kt hostgroup"
+ content_source: capsule.example.com
+ lifecycle_environment: "Production"
+ content_view: "My content view"
+ parameters:
+ - name: "kt_activation_keys"
+ value: "my_prod_ak"
+
+ - name: "Delete a Hostgroup"
+ redhat.satellite.hostgroup:
+ name: "new_hostgroup"
+ server_url: "https://satellite.example.com"
+ username: "admin"
+ password: "changeme"
+ state: absent
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__return-entity:
+
+ .. rst-class:: ansible-option-title
+
+ **entity**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Final state of the affected entities grouped by their type.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.hostgroup_module__return-entity/hostgroups:
+
+ .. rst-class:: ansible-option-title
+
+ **hostgroups**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ List of hostgroups.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+
+ .. raw:: html
+
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Manisha Singhal (@Manisha15) ATIX AG
+- Baptiste Agasse (@bagasse)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. raw:: html
+
+
+ Issue Tracker
+ Homepage
+ Repository (Sources)
+
+
+.. Parsing errors
+
diff --git a/3.11.0/_sources/plugins/http_proxy_module.rst.txt b/3.11.0/_sources/plugins/http_proxy_module.rst.txt
new file mode 100644
index 00000000..6f855a29
--- /dev/null
+++ b/3.11.0/_sources/plugins/http_proxy_module.rst.txt
@@ -0,0 +1,765 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. role:: ansible-attribute-support-label
+.. role:: ansible-attribute-support-property
+.. role:: ansible-attribute-support-full
+.. role:: ansible-attribute-support-partial
+.. role:: ansible-attribute-support-none
+.. role:: ansible-attribute-support-na
+.. role:: ansible-option-type
+.. role:: ansible-option-elements
+.. role:: ansible-option-required
+.. role:: ansible-option-versionadded
+.. role:: ansible-option-aliases
+.. role:: ansible-option-choices
+.. role:: ansible-option-choices-default-mark
+.. role:: ansible-option-default-bold
+.. role:: ansible-option-configuration
+.. role:: ansible-option-returned-bold
+.. role:: ansible-option-sample-bold
+
+.. Anchors
+
+.. _ansible_collections.redhat.satellite.http_proxy_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+redhat.satellite.http_proxy module -- Manage HTTP Proxies
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `redhat.satellite collection `_ (version 3.11.0).
+
+ To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
+ You need further requirements to be able to use this module,
+ see :ref:`Requirements ` for details.
+
+ To use it in a playbook, specify: :code:`redhat.satellite.http_proxy`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in redhat.satellite 1.1.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Create, update, and delete HTTP Proxies
+
+
+.. Aliases
+
+
+.. Requirements
+
+.. _ansible_collections.redhat.satellite.http_proxy_module_requirements:
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- requests
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-locations:
+
+ .. rst-class:: ansible-option-title
+
+ **locations**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of locations the entity should be assigned to
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ The HTTP Proxy name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-organizations:
+
+ .. rst-class:: ansible-option-title
+
+ **organizations**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=string`
+
+ .. raw:: html
+
+
+
+ List of organizations the entity should be assigned to
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Password of the user accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-proxy_password:
+
+ .. rst-class:: ansible-option-title
+
+ **proxy_password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Password used to authenticate with the HTTP Proxy
+
+ When this parameter is set, the module will not be idempotent.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-proxy_username:
+
+ .. rst-class:: ansible-option-title
+
+ **proxy_username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Username used to authenticate with the HTTP Proxy
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-server_url:
+
+ .. rst-class:: ansible-option-title
+
+ **server_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ State of the entity
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-url:
+
+ .. rst-class:: ansible-option-title
+
+ **url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ URL of the HTTP Proxy
+
+ Required when creating a new HTTP Proxy.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Username accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to verify the TLS certificates of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\ will be used instead.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in check\_mode and return changed status prediction without modifying the entity
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in check\_mode), when in diff mode
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: create example.org proxy
+ redhat.satellite.http_proxy:
+ name: "example.org"
+ url: "http://example.org:3128"
+ locations:
+ - "Munich"
+ organizations:
+ - "ACME"
+ server_url: "https://satellite.example.com"
+ username: "admin"
+ password: "changeme"
+ state: present
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__return-entity:
+
+ .. rst-class:: ansible-option-title
+
+ **entity**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Final state of the affected entities grouped by their type.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.http_proxy_module__return-entity/http_proxies:
+
+ .. rst-class:: ansible-option-title
+
+ **http_proxies**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ List of HTTP proxies.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+
+ .. raw:: html
+
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Evgeni Golov (@evgeni)
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. raw:: html
+
+
+ Issue Tracker
+ Homepage
+ Repository (Sources)
+
+
+.. Parsing errors
+
diff --git a/3.11.0/_sources/plugins/image_module.rst.txt b/3.11.0/_sources/plugins/image_module.rst.txt
new file mode 100644
index 00000000..9eb813a0
--- /dev/null
+++ b/3.11.0/_sources/plugins/image_module.rst.txt
@@ -0,0 +1,842 @@
+
+.. Document meta
+
+:orphan:
+
+.. |antsibull-internal-nbsp| unicode:: 0xA0
+ :trim:
+
+.. role:: ansible-attribute-support-label
+.. role:: ansible-attribute-support-property
+.. role:: ansible-attribute-support-full
+.. role:: ansible-attribute-support-partial
+.. role:: ansible-attribute-support-none
+.. role:: ansible-attribute-support-na
+.. role:: ansible-option-type
+.. role:: ansible-option-elements
+.. role:: ansible-option-required
+.. role:: ansible-option-versionadded
+.. role:: ansible-option-aliases
+.. role:: ansible-option-choices
+.. role:: ansible-option-choices-default-mark
+.. role:: ansible-option-default-bold
+.. role:: ansible-option-configuration
+.. role:: ansible-option-returned-bold
+.. role:: ansible-option-sample-bold
+
+.. Anchors
+
+.. _ansible_collections.redhat.satellite.image_module:
+
+.. Anchors: short name for ansible.builtin
+
+.. Title
+
+redhat.satellite.image module -- Manage Images
+++++++++++++++++++++++++++++++++++++++++++++++
+
+.. Collection note
+
+.. note::
+ This module is part of the `redhat.satellite collection `_ (version 3.11.0).
+
+ To install it, use: :code:`ansible-galaxy collection install redhat.satellite`.
+ You need further requirements to be able to use this module,
+ see :ref:`Requirements ` for details.
+
+ To use it in a playbook, specify: :code:`redhat.satellite.image`.
+
+.. version_added
+
+.. rst-class:: ansible-version-added
+
+New in redhat.satellite 1.0.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. Deprecated
+
+
+Synopsis
+--------
+
+.. Description
+
+- Create, update, and delete Images
+
+
+.. Aliases
+
+Aliases: foreman_image
+
+.. Requirements
+
+.. _ansible_collections.redhat.satellite.image_module_requirements:
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- requests
+
+
+
+
+
+
+.. Options
+
+Parameters
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Parameter
+ - Comments
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-architecture:
+
+ .. rst-class:: ansible-option-title
+
+ **architecture**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ architecture of the image
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-compute_resource:
+
+ .. rst-class:: ansible-option-title
+
+ **compute_resource**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Compute resource the image is assigned to
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-image_password:
+
+ .. rst-class:: ansible-option-title
+
+ **image_password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ Password that is used to login into the operating system
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-image_username:
+
+ .. rst-class:: ansible-option-title
+
+ **image_username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Username that is used to login into the operating system
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-name:
+
+ .. rst-class:: ansible-option-title
+
+ **name**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Image name
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-operatingsystem:
+
+ .. rst-class:: ansible-option-title
+
+ **operatingsystem**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Operating systems are looked up by their title which is composed as "\ \.\".
+
+ You can omit the version part as long as you only have one operating system by that name.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-password:
+
+ .. rst-class:: ansible-option-title
+
+ **password**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Password of the user accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_PASSWORD`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-server_url:
+
+ .. rst-class:: ansible-option-title
+
+ **server_url**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ URL of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_SERVER\_URL`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-state:
+
+ .. rst-class:: ansible-option-title
+
+ **state**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string`
+
+ .. raw:: html
+
+
+
+ State of the entity
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
+ - :ansible-option-choices-entry:`"absent"`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-user_data:
+
+ .. rst-class:: ansible-option-title
+
+ **user_data**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Image supports user\_data
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry:`true`
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-username:
+
+ .. rst-class:: ansible-option-title
+
+ **username**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ Username accessing the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_USERNAME`\ will be used instead.
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-image_uuid:
+ .. _ansible_collections.redhat.satellite.image_module__parameter-uuid:
+
+ .. rst-class:: ansible-option-title
+
+ **uuid**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-aliases:`aliases: image_uuid`
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`string` / :ansible-option-required:`required`
+
+ .. raw:: html
+
+
+
+ UUID or Marketplace URN of the operatingsystem image
+
+
+ .. raw:: html
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__parameter-validate_certs:
+
+ .. rst-class:: ansible-option-title
+
+ **validate_certs**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`boolean`
+
+ .. raw:: html
+
+
+
+ Whether or not to verify the TLS certificates of the Foreman server.
+
+ If the value is not specified in the task, the value of environment variable \ :literal:`SATELLITE\_VALIDATE\_CERTS`\ will be used instead.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-choices:`Choices:`
+
+ - :ansible-option-choices-entry:`false`
+ - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`
+
+
+ .. raw:: html
+
+
+
+
+.. Attributes
+
+
+Attributes
+----------
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Attribute
+ - Support
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__attribute-check_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **check_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Can run in check\_mode and return changed status prediction without modifying the entity
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__attribute-diff_mode:
+
+ .. rst-class:: ansible-option-title
+
+ **diff_mode**
+
+ .. raw:: html
+
+
+
+ .. raw:: html
+
+
+
+ :ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full`
+
+
+ .. raw:: html
+
+
+
+ - .. raw:: html
+
+
+
+ Will return details on what has changed (or possibly needs changing in check\_mode), when in diff mode
+
+
+ .. raw:: html
+
+
+
+
+
+.. Notes
+
+
+.. Seealso
+
+
+.. Examples
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+ - name: create Image for EC2
+ redhat.satellite.image:
+ name: CentOS
+ image_uuid: "ami-0ff760d16d9497662"
+ image_username: "centos"
+ operatingsystem: "CentOS 7"
+ compute_resource: "AWS"
+ architecture: "x86_64"
+
+
+
+
+.. Facts
+
+
+.. Return values
+
+Return Values
+-------------
+Common return values are documented :ref:`here `, the following are the fields unique to this module:
+
+.. rst-class:: ansible-option-table
+
+.. list-table::
+ :width: 100%
+ :widths: auto
+ :header-rows: 1
+
+ * - Key
+ - Description
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__return-entity:
+
+ .. rst-class:: ansible-option-title
+
+ **entity**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`dictionary`
+
+ .. raw:: html
+
+
+
+ Final state of the affected entities grouped by their type.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+
+ .. raw:: html
+
+
+
+
+ * - .. raw:: html
+
+
+
+
+ .. _ansible_collections.redhat.satellite.image_module__return-entity/images:
+
+ .. rst-class:: ansible-option-title
+
+ **images**
+
+ .. raw:: html
+
+
+
+ .. rst-class:: ansible-option-type-line
+
+ :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`
+
+ .. raw:: html
+
+
+
+ List of images.
+
+
+ .. rst-class:: ansible-option-line
+
+ :ansible-option-returned-bold:`Returned:` success
+
+
+ .. raw:: html
+
+
+
+
+
+
+.. Status (Presently only deprecated)
+
+
+.. Authors
+
+Authors
+~~~~~~~
+
+- Mark Hlawatschek (@hlawatschek) ATIX AG
+
+
+
+.. Extra links
+
+Collection links
+~~~~~~~~~~~~~~~~
+
+.. raw:: html
+
+
+ Issue Tracker
+ Homepage
+ Repository (Sources)
+
+
+.. Parsing errors
+
diff --git a/3.11.0/_sources/plugins/index.rst.txt b/3.11.0/_sources/plugins/index.rst.txt
new file mode 100644
index 00000000..29e503ed
--- /dev/null
+++ b/3.11.0/_sources/plugins/index.rst.txt
@@ -0,0 +1,331 @@
+
+
+
+.. _plugins_in_redhat.satellite:
+
+Redhat.Satellite
+================
+
+Collection version 3.11.0
+
+.. contents::
+ :local:
+ :depth: 1
+
+Description
+-----------
+
+Ansible Modules to manage Satellite installations
+
+**Authors:**
+
+* @lessfoobar <59063885+lessfoobar@users.noreply.github.com>
+* Adam Růžička
+* AlanCoding
+* Andrew Kofink
+* Anthony Green
+* Anton
+* Baptiste Agasse
+* Bernhard Hopfenmüller
+* Bernhard Suttner
+* Bryan Kearney
+* Chris Forkner
+* Chris Hindman
+* Chris Snell
+* Christoffer Reijer
+* Dave Thomas <11580510+dthomastx@users.noreply.github.com>
+* Deric Crago
+* Eric D. Helms
+* Eric L
+* Ethan
+* Evgeni Golov
+* Ewoud Kohl van Wijngaarden
+* Felix Fontein
+* Gerald Vogt
+* Greg Swift
+* Griffin Sullivan
+* Hideki Saito
+* Ismael Puerto
+* Jameer Pathan
+* James Jeffers
+* James Stuart
+* Jeffrey van Pelt
+* Jeremy Albinet
+* Jeremy Lenz
+* Jesper Reenberg
+* John Berninger
+* Josh Swanson
+* Kenny Tordeurs
+* Kirill Shirinkin
+* Leos Stejskal
+* Lester Cheung
+* Lester Claudio
+* Lucas Bickel
+* Lukáš Zapletal