ansible-galaxy
ロールおよびコレクションに関する様々な操作を実行します。
共通オプション
- --version
プログラムバージョン番号、設定ファイルの場所、設定したモジュール検索パス、モジュールの場所、実行可能な場所、および終了を表示します。
- -h, --help
ヘルプメッセージを表示して終了します。
- -v, --verbose
詳細モード (-vvv の場合はより詳細になる。-vvvv の場合は接続のデバッグを有効にする)
アクション
コレクション
Ansible Galaxy コレクションでアクションを実行します。以下で示すように、init/install などの追加アクションと組み合わせる必要があります。
collection download
- --clear-response-cache
既存のサーバーの応答キャッシュを消去します。
- --no-cache
サーバーの応答キャッシュを使用しないでください。
- --pre
リリース前のバージョンを含めます。セマンティックバージョニングのプレリリースはデフォルトで無視されます
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -n, --no-deps
依存関係としてリストされているコレクションはダウンロードしないでください。
- -p <DOWNLOAD_PATH>, --download-path <DOWNLOAD_PATH>
コレクションをダウンロードするディレクトリー。
- -r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>
ダウンロードするコレクションの一覧を含むファイル。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
collection init
Galaxy メタデータ形式に準拠するロールまたはコレクションのスケルトンフレームワークを作成します。ロールまたはコレクション名が必要です。コレクション名は <namespace>.<collection> の形式にする必要があります。
- --collection-skeleton <COLLECTION_SKELETON>
新しいコレクションの基となるコレクションスケルトンへのパス。
- --init-path <INIT_PATH>
スケルトンコレクションが作成されるパス。デフォルトは現在の作業ディレクトリーです。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -f, --force
既存のロールまたはコレクションの上書きを強制します。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
collection build
Ansible Galaxy などの中央リポジトリーに格納できる Ansible Galaxy コレクションアーティファクトを構築します。デフォルトでは、このコマンドは現在の作業ディレクトリーから構築されます。必要に応じて、コレクション入力パスを渡すことができます (galaxy.yml ファイルの場所です)。
- --output-path <OUTPUT_PATH>
コレクションが構築されるパス。デフォルトは現在の作業ディレクトリーです。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -f, --force
既存のロールまたはコレクションの上書きを強制します。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
collection publish
コレクションを Ansible Galaxy に公開します。公開するには、コレクション tarball へのパスが必要になります。
- --import-timeout <IMPORT_TIMEOUT>
コレクションのインポートプロセスが完了するのを待つ時間。
- --no-wait
インポートの検証結果を待ちません。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
collection install
- --clear-response-cache
既存のサーバーの応答キャッシュを消去します。
- --force-with-deps
既存のコレクションおよびその依存関係を強制的に上書きします。
- --no-cache
サーバーの応答キャッシュを使用しないでください。
- --pre
リリース前のバージョンを含めます。セマンティックバージョニングのプレリリースはデフォルトで無視されます
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -U, --upgrade
インストールされたコレクションアーティファクトをアップグレードします。--no-deps が提供されている場合を除き依存関係も更新されます。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -f, --force
既存のロールまたはコレクションの上書きを強制します。
- -i, --ignore-errors
インストール時にエラーを無視し、次の指定されたコレクションで続行します。依存関係の競合エラーは無視しません。
- -n, --no-deps
依存関係として一覧表示されているコレクションはダウンロードしないでください。
- -p <COLLECTIONS_PATH>, --collections-path <COLLECTIONS_PATH>
コレクションを含むディレクトリーへのパス。
- -r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>
インストールするコレクションの一覧を含むファイル。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
collection list
インストール済みのコレクションまたはロールを一覧表示します。
- --format <OUTPUT_FORMAT>
コレクションの一覧を表示する形式。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -p, --collections-path
デフォルトの COLLECTIONS_PATHS に加えて、コレクションを検索する 1 つ以上のディレクトリー。複数のパスは、「:」で区切ります。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
collection verify
- --offline
通常のマニフェストハッシュのためにサーバーに問い合わせることなく、コレクションの整合性をローカルで検証します。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -i, --ignore-errors
検証時のエラーを無視し、次の指定されたコレクションで続行します。
- -p, --collections-path
デフォルトの COLLECTIONS_PATHS に加えて、コレクションを検索する 1 つ以上のディレクトリー。複数のパスは、「:」で区切ります。
- -r <REQUIREMENTS>, --requirements-file <REQUIREMENTS>
検証するコレクションの一覧を含むファイル。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
ロール
Ansible Galaxy ロールで操作を実行します。以下のように delete/install/init などのアクションと組み合わせる必要があります。
role init
Galaxy メタデータ形式に準拠するロールまたはコレクションのスケルトンフレームワークを作成します。ロールまたはコレクション名が必要です。コレクション名は <namespace>.<collection> の形式にする必要があります。
- --init-path <INIT_PATH>
スケルトンロールが作成されるパス。デフォルトは現在の作業ディレクトリーです。
- --offline
ロールの作成時に galaxy API にクエリーを実行しないでください。
- --role-skeleton <ROLE_SKELETON>
新しいロールの基となるロールスケルトンへのパス。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- --type <ROLE_TYPE>
別のロールタイプを使用して初期化します。有効なタイプには、「container」、「apb」、および「network」が含まれます。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -f, --force
既存のロールまたはコレクションの上書きを強制します。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
role remove
ローカルシステムから引数として渡されたロールの一覧を削除します。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -p, --roles-path
ロールを含むディレクトリーへのパスです。デフォルトは DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles で設定される最初の書き込み可能なファイルです。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
role delete
Ansible Galaxy からロールを削除します。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
role list
インストール済みのコレクションまたはロールを一覧表示します。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -p, --roles-path
ロールを含むディレクトリーへのパスです。デフォルトは DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles で設定される最初の書き込み可能なファイルです。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
role search
Ansible Galaxy サーバーでロールを検索します。
- --author <AUTHOR>
GitHub ユーザー名
- --galaxy-tags <GALAXY_TAGS>
フィルタリングする galaxy タグの一覧を表示します。
- --platforms <PLATFORMS>
フィルタリングする OS プラットフォームの一覧を表示します。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
role import
Ansible Galaxy にロールをインポートするのに使用します。
- --branch <REFERENCE>
インポートするブランチの名前。デフォルトではリポジトリーのデフォルトブランチ (通常は master) に設定されます。
- --no-wait
インポートの結果を待ちません。
- --role-name <ROLE_NAME>
ロールに付与すべき名前 (リポジトリー名とは異なる場合)
- --status
指定した github_user/github_repo の、最新のインポート要求ステータスを確認します。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
role setup
Ansible Galaxy ロールの Github または Travis からの統合を設定します。
- --list
すべての統合の一覧を表示します。
- --remove <REMOVE_ID>
指定の ID 値に一致するインテグレーションを削除します。ID の値を表示するには --list を使用します。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -p, --roles-path
ロールを含むディレクトリーへのパスです。デフォルトは DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles で設定される最初の書き込み可能なファイルです。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
role info
インストールされているロールに関する詳細情報と、galaxy API で利用可能な情報を出力します。
- --offline
ロールの作成時に galaxy API にクエリーを実行しないでください。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -p, --roles-path
ロールを含むディレクトリーへのパスです。デフォルトは DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles で設定される最初の書き込み可能なファイルです。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
role install
- --force-with-deps
既存のロールとその依存関係を強制的に上書きします。
- --token <API_KEY>, --api-key <API_KEY>
https://galaxy.ansible.com/me/preferences で見つかる Ansible Galaxy API キー。
- -c, --ignore-certs
SSL 証明書の検証エラーを無視します。
- -f, --force
既存のロールまたはコレクションの上書きを強制します。
- -g, --keep-scm-meta
ロールをパッケージ化する際に、scm アーカイブオプションの代わりに tar を使用します。
- -i, --ignore-errors
エラーを無視して、次に指定したロールで続行します。
- -n, --no-deps
依存関係としてリストされているロールはダウンロードしないでください。
- -p, --roles-path
ロールを含むディレクトリーへのパスです。デフォルトは DEFAULT_ROLES_PATH: ~/.ansible/roles:/usr/share/ansible/roles:/etc/ansible/roles で設定される最初の書き込み可能なファイルです。
- -r <REQUIREMENTS>, --role-file <REQUIREMENTS>
インストールするロールの一覧を含むファイル。
- -s <API_SERVER>, --server <API_SERVER>
Galaxy API サーバー URL
環境
以下の環境変数を指定できます。
ANSIBLE_CONFIG -- デフォルトの Ansible 設定ファイルを上書きします
ansible.cfg のほとんどのオプションで、さらに多くのものが利用できます。