The Ansible IBM Cloud collection includes a variety of Ansible content to help automate the management of IBM Cloud instances. This collection is maintained by IBM.
This collection has been tested against following Ansible versions: >=2.9.10.
Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.
This collection depends on the respective IBM-Cloud service SDKs for Python (required SDKs).
This collection has been tested against following Ansible versions: >=3.9.
You can install the IBM Cloud collection with the Ansible Galaxy CLI:
ansible-galaxy collection install ibm.cloud
You can also include it in a requirements.yml
file and install it with ansible-galaxy collection install -r requirements.yml
, using the format:
---
collections:
- name: ibm.cloud
A specific version of the collection can be installed by using the version
keyword in the requirements.yml
file:
---
collections:
- name: ibm.cloud
version: 1.0.0
The python module dependencies are not installed by ansible-galaxy
. They can
be manually installed using pip:
pip install requirements.txt
or:
pip install ibm-platform-services
pip install ibm-schematics
pip install ibm-cloud-sdk-core
-
Install [Python3]
-
[RedHat Ansible] 2.9+
pip install "ansible>=2.9.10"
- Build collection using below command. This will generate a tar.gz file in the current working directory
ansible-galaxy collection build -f
- Install the collection using below command.
ansible-galaxy collection install <above generated tar.gz file name> -f
- The python module dependencies are not installed by ansible-galaxy. They can be manually installed using pip:
pip install requirements.txt
You can either call modules by their Fully Qualified Collection Namespace (FQCN), such as ibm.cloud.ibm_resource_group
, or you can call modules by their short name if you list the ibm.cloud
collection in the playbook's collections
keyword:
---
- name: Create resource Group
ibm_resource_group:
name: "{{ resource_group_name }}"
register: rg_create_output
We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the IBM Cloud collection repository.
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Collection Developer Guide
- Ansible Community code of conduct
GNU GENERAL PUBLIC LICENSE v3.0 or later.
See LICENSE to see the full text.