cephadm-ansible modules options

This section lists the available options for the cephadm-ansible modules.

Options listed in the following tables with the required value as true need to be set when using the modules in your Ansible playbooks. Options that are listed with a default value of true indicate that the option is automatically set when using the modules and you do not need to specify it in your playbook. For example, for the cephadm_bootstrap module, the Ceph Dashboard is installed unless you set dashboard: false.

Table 1. Available options for the cephadm_bootstrap module
cephadm_bootstrap Description Required Default
mon_ip Ceph Monitor IP address. true None
image Ceph container image. false None
docker Use docker instead of podman. false None
fsid Define the Ceph FSID. false None
pull Pull the Ceph container image. false true
dashboard Deploy the Ceph Dashboard. false true
dashboard_user Specify a specific Ceph Dashboard user. false None
dashboard_password Ceph Dashboard password. false None
monitoring Deploy the monitoring stack. false true
firewalld Manage firewall rules with firewalld. false true
allow_overwrite Allow overwrite of existing --output-config, --output-keyring, or --output-pub-ssh-key files. false false
registry_url URL for custom registry. false None
registry_username Username for custom registry. false None
registry_password Password for custom registry. false None
registry_json JSON file with custom registry login information. false None
ssh_user SSH user to use for cephadm ssh to hosts. false None
ssh_config SSH config file path for cephadm SSH client. false None
allow_fqdn_hostname Allow hostname that is a fully-qualified domain name (FQDN). false false
cluster_network Subnet to use for cluster replication, recovery and heartbeats. false None
Table 2. Available options for the ceph_orch_host module
ceph_orch_host Description Required Default
fsid The FSID of the Ceph cluster to interact with. false None
image The Ceph container image to use. false None
name Name of the host to add, remove, or update. true None
address IP address of the host. true when state is present. None
set_admin_label Set the _admin label on the specified host. false false
labels The list of labels to apply to the host. false []
state If set to present, it ensures the name specified in name is present. If set to absent, it removes the host specified in name. If set to drain, it schedules to remove all daemons from the host specified in name. false present
Table 3. Available options for the ceph_config module
ceph_config Description Required Default
fsid The FSID of the Ceph cluster to interact with. false None
image The Ceph container image to use. false None
action Whether to set or get the parameter specified in option. false set
who Which daemon to set the configuration to. true None
option Name of the parameter to set or get. true None
value Value of the parameter to set. true if action is set None
Table 4. Available options for the ceph_orch_apply module
ceph_orch_apply Description Required
fsid The FSID of the Ceph cluster to interact with. false
image The Ceph container image to use. false
spec The service specification to apply. true
Table 5. Available options for the ceph_orch_daemon module
ceph_orch_daemon Description Required
fsid The FSID of the Ceph cluster to interact with. false
image The Ceph container image to use. false
state The desired state of the service specified in name.

true

  • If started, it ensures the service is started.
  • If stopped, it ensures the service is stopped.
  • If restarted, it will restart the service.
daemon_id The ID of the service. true
daemon_type The type of service. true
Table 6. Available options for the cephadm_registry_login module
cephadm_registry_login Description Required Default
state Login or logout of a registry. false login
docker Use docker instead of podman. false None
registry_url The URL for custom registry. false None
registry_username Username for custom registry. true when state is login. None
registry_password Password for custom registry. true when state is login. None
registry_json The path to a JSON file. This file must be present on remote hosts prior to running this task. This option is currently not supported. None None