ansible-galaxy
ansible-galaxy
Perform various Role related operations.
Synopsis
ansible-galaxy [delete|import|info|init|install|list|login|remove|search|setup] [--help] [options] ...Description
command to manage Ansible roles in shared repositories, the default of which is Ansible Galaxy https://galaxy.ansible.com.
Common Options
--list- List all of your integrations.
--remove <REMOVE_ID>- Remove the integration matching the provided ID value. Use –list to see ID values.
--version- show program’s version number, config file location, configured module search path, module location, executable location and exit
-c, --ignore-certs- Ignore SSL certificate validation errors.
-h, --help- show this help message and exit
-s <API_SERVER>, --server <API_SERVER>- The API server destination
-v, --verbose- verbose mode (-vvv for more, -vvvv to enable connection debugging)
Actions
login
verify user’s identify via GitHub and retrieve an auth token from Ansible Galaxy.
--github-token <TOKEN>- Identify with github token rather than username and password.
search
searches for roles on the Ansible Galaxy server
--author <AUTHOR>- GitHub username
--galaxy-tags <GALAXY_TAGS>- list of galaxy tags to filter by
--platforms <PLATFORMS>- list of OS platforms to filter by
-p, --roles-path- The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfg file (/etc/ansible/roles if not configured)
delete
Delete a role from Ansible Galaxy.
info
prints out detailed information about an installed role as well as info available from the galaxy API.
--offline- Don’t query the galaxy API when creating roles
-p, --roles-path- The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfg file (/etc/ansible/roles if not configured)
list
lists the roles installed on the local system or matches a single role passed as an argument.
-p, --roles-path- The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfg file (/etc/ansible/roles if not configured)
import
used to import a role into Ansible Galaxy
--branch <REFERENCE>- The name of a branch to import. Defaults to the repository’s default branch (usually master)
--no-wait- Don’t wait for import results.
--role-name <ROLE_NAME>- The name the role should have, if different than the repo name
--status- Check the status of the most recent import request for given github_user/github_repo.
install
uses the args list of roles to be installed, unless -f was specified. The list of roles can be a name (which will be downloaded via the galaxy API and github), or it can be a local .tar.gz file.
--force-with-deps- Force overwriting an existing role and it’s dependencies
-f, --force- Force overwriting an existing role
-g, --keep-scm-meta- Use tar instead of the scm archive option when packaging the role
-i, --ignore-errors- Ignore errors and continue with the next specified role.
-n, --no-deps- Don’t download roles listed as dependencies
-p, --roles-path- The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfg file (/etc/ansible/roles if not configured)
-r <ROLE_FILE>, --role-file <ROLE_FILE>- A file containing a list of roles to be imported
init
creates the skeleton framework of a role that complies with the galaxy metadata format.
--init-path <INIT_PATH>- The path in which the skeleton role will be created. The default is the current working directory.
--offline- Don’t query the galaxy API when creating roles
--role-skeleton <ROLE_SKELETON>- The path to a role skeleton that the new role should be based upon.
--type <ROLE_TYPE>- Initialize using an alternate role type. Valid types include: ‘container’, ‘apb’ and ‘network’.
-f, --force- Force overwriting an existing role
remove
removes the list of roles passed as arguments from the local system.
-p, --roles-path- The path to the directory containing your roles. The default is the roles_path configured in your ansible.cfg file (/etc/ansible/roles if not configured)
setup
Setup an integration from GitHub or Travis for Ansible Galaxy roles
--list- List all of your integrations.
--remove <REMOVE_ID>- Remove the integration matching the provided ID value. Use –list to see ID values.
Environment
The following environment variables may be specified.
ANSIBLE_CONFIG – Override the default ansible config file
Many more are available for most options in ansible.cfg
Files
/etc/ansible/ansible.cfg – Config file, used if present
~/.ansible.cfg – User config file, overrides the default config if present
Author
Ansible was originally written by Michael DeHaan.
See the AUTHORS file for a complete list of contributors.
License
Ansible is released under the terms of the GPLv3+ License.
See also
ansible(1), ansible-config(1), ansible-console(1), ansible-doc(1), ansible-galaxy(1), ansible-inventory(1), ansible-playbook(1), ansible-pull(1), ansible-vault(1),
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/cli/ansible-galaxy.html
