kavya498 / ansible.ibm.cloud

IBM Cloud Collection

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.

Ansible version compatibility

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.

Python version compatibility

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.

Included content

Modules

Service	Name
Catalog Management	ibm_cm_catalog ibm_cm_offering ibm_cm_offering_instance ibm_cm_version
IAM Access Group	ibm_iam_access_group ibm_iam_access_group_info ibm_iam_access_group_members ibm_iam_access_group_members_info ibm_iam_access_group_rule ibm_iam_access_group_rule_info ibm_iam_access_group_rules_info ibm_iam_access_groups_info
IAM Identity Services	ibm_iam_service_id ibm_iam_service_id_info ibm_iam_service_ids_info
Resource Manager	ibm_resource_group ibm_resource_group_info ibm_resource_groups_info ibm_resource_quota_info ibm_resource_quotas_info
Resource Controller	ibm_resource_instance ibm_resource_instance_info ibm_resource_instances_info ibm_resource_key ibm_resource_key_info ibm_resource_keys_info ibm_resource_alias ibm_resource_alias_info ibm_resource_aliases_info ibm_resource_binding ibm_resource_binding_info ibm_resource_bindings_info ibm_resource_reclamations_info
Schematics	ibm_schematics_action ibm_schematics_action_info ibm_schematics_inventory ibm_schematics_inventory_info ibm_schematics_job ibm_schematics_job_info ibm_schematics_resource_query ibm_schematics_resource_query_info ibm_schematics_state_info ibm_schematics_workspace ibm_schematics_workspace_info ibm_schematics_workspace_activity_info

Installing this collection

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

Working locally with this collection

Prerequisites

1. Install [Python3]

2. [RedHat Ansible] 2.9+

   pip install "ansible>=2.9.10"
   

Build and Installation

1. Build collection using below command. This will generate a tar.gz file in the current working directory

ansible-galaxy collection build -f

2. Install the collection using below command.

ansible-galaxy collection install <above generated tar.gz file name> -f

3. The python module dependencies are not installed by ansible-galaxy. They can be manually installed using pip:

pip install requirements.txt

Using this collection

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

Contributing to this collection

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.

Release notes

Roadmap

More information

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Collection Developer Guide
• Ansible Community code of conduct

Licensing

Apache License v2.0 or later.

See LICENSE to see the full text.