ansible-galaxy(1)

1ANSIBLE-GALAXY(1)       System administration commands       ANSIBLE-GALAXY(1)
2
3
4

NAME

6       ansible-galaxy - Perform various Role related operations.
7

SYNOPSIS

9       ansible-galaxy
10       [delete|import|info|init|install|list|login|remove|search|setup]
11       [--help] [options] ...
12

DESCRIPTION

14       command  to manage Ansible roles in shared repositories, the default of
15       which is Ansible Galaxy https://galaxy.ansible.com.
16

COMMON OPTIONS

18       --version
19          show program's version number, config file location, configured mod‐
20          ule search path, module location, executable location and exit
21
22       -c, --ignore-certs
23          Ignore SSL certificate validation errors.
24
25       -h, --help
26          show this help message and exit
27
28       -s 'API_SERVER', --server 'API_SERVER'
29          The API server destination
30
31       -v, --verbose
32          verbose mode (-vvv for more, -vvvv to enable connection debugging)
33

ACTIONS

35       info   prints  out detailed information about an installed role as well
36              as info available from the galaxy API.
37
38              --offline
39                 Don't query the galaxy API when creating roles
40
41              -p,   --roles-path
42                 The path to the directory containing your roles. The  default
43                 is   the  roles_path  configured  in  your  ansible.cfg  file
44                 (/etc/ansible/roles if not configured)
45
46       search searches for roles on the Ansible Galaxy server
47
48              --author 'AUTHOR'
49                 GitHub username
50
51              --galaxy-tags 'GALAXY_TAGS'
52                 list of galaxy tags to filter by
53
54              --platforms 'PLATFORMS'
55                 list of OS platforms to filter by
56
57              -p,   --roles-path
58                 The path to the directory containing your roles. The  default
59                 is   the  roles_path  configured  in  your  ansible.cfg  file
60                 (/etc/ansible/roles if not configured)
61
62       setup  Setup an integration from GitHub or Travis  for  Ansible  Galaxy
63              roles
64
65              --list
66                 List all of your integrations.
67
68              --remove 'REMOVE_ID'
69                 Remove  the  integration  matching the provided ID value. Use
70                 --list to see ID values.
71
72       list   lists the roles installed on the local system or matches a  sin‐
73              gle role passed as an argument.
74
75              -p,   --roles-path
76                 The  path to the directory containing your roles. The default
77                 is  the  roles_path  configured  in  your  ansible.cfg   file
78                 (/etc/ansible/roles if not configured)
79
80       remove removes  the  list  of  roles passed as arguments from the local
81              system.
82
83              -p,   --roles-path
84                 The path to the directory containing your roles. The  default
85                 is   the  roles_path  configured  in  your  ansible.cfg  file
86                 (/etc/ansible/roles if not configured)
87
88       init   creates the skeleton framework of a role that complies with  the
89              galaxy metadata format.
90
91              --init-path 'INIT_PATH'
92                 The  path  in  which  the  skeleton role will be created. The
93                 default is the current working directory.
94
95              --offline
96                 Don't query the galaxy API when creating roles
97
98              --role-skeleton 'ROLE_SKELETON'
99                 The path to a role skeleton that the new role should be based
100                 upon.
101
102              --type 'ROLE_TYPE'
103                 Initialize using an alternate role type. Valid types include:
104                 'container', 'apb' and 'network'.
105
106              -f,   --force
107                 Force overwriting an existing role
108
109       install
110              uses the args list of roles to be installed, unless -f was spec‐
111              ified. The list of roles
112
113       System  Message:  WARNING/2  (docs/man/man1/ansible-galaxy.1.rst:, line
114       160)
115              Definition list ends without a blank line; unexpected unindent.
116
117              can be a name (which will be downloaded via the galaxy  API  and
118              github), or it can be a local .tar.gz file.
119          --force-with-deps
120              Force overwriting an existing role and it's dependencies
121
122          -f,   --force
123              Force overwriting an existing role
124
125          -g,   --keep-scm-meta
126              Use  tar  instead  of  the scm archive option when packaging the
127              role
128
129          -i,   --ignore-errors
130              Ignore errors and continue with the next specified role.
131
132          -n,   --no-deps
133              Don't download roles listed as dependencies
134
135          -p,   --roles-path
136              The path to the directory containing your roles. The default  is
137              the  roles_path  configured in your ansible.cfg file (/etc/ansi‐
138              ble/roles if not configured)
139
140          -r 'ROLE_FILE',   --role-file 'ROLE_FILE'
141              A file containing a list of roles to be imported
142
143       import used to import a role into Ansible Galaxy
144
145              --branch 'REFERENCE'
146                 The name of a branch to import. Defaults to the  repository's
147                 default branch (usually master)
148
149              --no-wait
150                 Don't wait for import results.
151
152              --role-name 'ROLE_NAME'
153                 The  name  the  role  should have, if different than the repo
154                 name
155
156              --status
157                 Check the status of the most recent import request for  given
158                 github_user/github_repo.
159
160       login  verify  user's  identify  via  GitHub and retrieve an auth token
161              from Ansible Galaxy.
162
163              --github-token 'TOKEN'
164                 Identify with github token rather than username and password.
165
166       delete Delete a role from Ansible Galaxy.
167

ENVIRONMENT

169       The following environment variables may be specified.
170
171       ANSIBLE_CONFIG -- Specify override location for the ansible config file
172
173       Many more are available for most options in ansible.cfg
174
175       For a full list  check  https://docs.ansible.com/.  or  use  the  ansi‐
176       ble-config command.
177

FILES

179       /etc/ansible/ansible.cfg -- Config file, used if present
180
181       ~/.ansible.cfg  --  User  config  file, overrides the default config if
182       present
183
184       ./ansible.cfg -- Local  config  file  (in  current  working  directory)
185       assumed to be 'project specific' and overrides the rest if present.
186
187       As  mentioned above, the ANSIBLE_CONFIG environment variable will over‐
188       ride all others.
189

AUTHOR

191       Ansible was originally written by Michael DeHaan.
192

COPYRIGHT

194       Copyright © 2018 Red Hat, Inc | Ansible.  Ansible is released under the
195       terms of the GPLv3 license.
196