Ansible Collection - commvault.ansible

Requirements
Install Instructions
Contribution Guidelines
License
About Commvault
Additional Roles
Documentation

Requirements

Ansible
Python 3.6+
CVPySDK
Commvault Software v11 SP16+ with Webconsole package installed

Install Instructions

Install cvpysdk using the requirements.txt file by running pip install -r requirements.txt

You can install this collection from the Ansible Galaxy using the command ansible-galaxy collection install commvault.ansible
You can also manually clone this repository in the given location <Default Ansible Collection Location>/ansible_collections/commvault/ and rename the repo folder from ansiblev2 to ansible to install this collection without using Ansible Galaxy

Contribution Guidelines

We welcome all the enhancements from everyone although we request the developer to follow some guidelines while interacting with the Commvault Ansible Collection codebase.
Before adding any enhancements/bug-fixes, we request you to open an Issue first.
The core team will go over the Issue and notify if it is required or already been worked on.
If the Issue is approved, the contributor can then make the changes to their fork and open a pull request.

Coding Considerations

All python code should be PEP8 compliant.
All changes should be consistent with the design of the SDK.
The code should be formatted using autopep8 with line-length set to 119 instead of default 79.
All changes and any new methods/classes should be properly documented.
The docstrings should be of the same format as existing docs.

Code of Conduct

Everyone interacting in the Commvault Ansible Collection project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the PyPA Code of Conduct.

License

CVPySDK and Commvault Ansible Collection are licensed under Apache 2.0

About Commvault

Commvault (NASDAQ: CVLT) is a publicly-traded data protection and information management software company headquartered in Tinton Falls, New Jersey. It was formed in 1988 as a development group in Bell Labs, and later became a business unit of AT&T Network Systems. It was incorporated in 1996. Commvault software assists organizations with data backup and recovery, cloud and infrastructure management, and retention and compliance.

Additional Roles

fs_deployment: For File System deployment
oracle_db_deployment: For Oracle DB Deployment

Documentation for the collection

Modules

commvault.ansible.login - login in to the commcell with provided credentials or auth token.
commvault.ansible.logout - logs out of the commcell.
commvault.ansible.request - makes a http request on the commserver api
commvault.ansible.deployment.install_software - to perform push installation from the commserve
commvault.ansible.deployment.download_software - to perform download software on commserve
commvault.ansible.deployment.push_updates - to push updates to the clients from commserver
commvault.ansible.file_servers.manage_content - to update the properties of a file server at subclient level.
commvault.ansible.file_servers.backup - to perform backup of a file server subclient.
commvault.ansible.file_servers.manage_plan - to change the plan associated to the client, backupset or subclient.
commvault.ansible.file_servers.restore - to perform restore of a file server subclient.
commvault.ansible.job.kill - kills the job
commvault.ansible.job.resume - resumes the job
commvault.ansible.job.status - checks the status of the job
commvault.ansible.job.suspend - suspends the job
commvault.ansible.plans.add - creates a plan
commvault.ansible.plans.delete - deletes a plan
commvault.ansible.workflow.execute - executes the workflow with the workflow name and inputs
commvault.ansible.workflow.deploy - deploys a workflow on the commcell.
commvault.ansible.workflow.export - exports the workflow to the directory location specified by the user.
commvault.ansible.workflow.import - imports a workflow to the commcell.
commvault.ansible.storage.disk.detail - gets details of a disk storage
commvault.ansible.storage.disk.add - creates a disk storage

commvault.ansible.login

Login in to the Commcell with provided credentials or auth token.

Synopsis

commvault.ansible.login can be used to login to Commcell using credentials or auth. token.

Options

Parameter	required	default	comments
webserver_hostname	yes		Hostname of the Web Server.
commcell_username	no		Commcell username.
commcell_password	no		Commcell password.
auth_token	no		A authentication token that can be used in place of commcell_username and commcell_password to login.
verify_ssl	no	True	Verify the SSL certificate of the commcell.
certificate_path	no		path of the CA_BUNDLE or directory with certificates of trusted CAs (including trusted self-signed certificates)

Returns

Name	Returned	Type	Description	Sample
authtoken	On success	str	The authentication token	QSDK value_of_token

Examples

- name: Log in to the Commcell
  commvault.ansible.login:
    webserver_hostname: 'web_server_hostname' 
    commcell_username: 'user'
    commcell_password: 'password'

commvault.ansible.logout

Logs out of the Commcell.

Synopsis

commvault.ansible.logout can be used to logout of the Commcell stored in the session file.

Examples

- name: Log out of the Commcell
  commvault.ansible.logout:

commvault.ansible.request

Makes a HTTP request on the Commserver API

Synopsis

This module makes HTTP requests to the Commserver API

Options

Parameter	required	choices	comments
webserver_hostname	no		Hostname of the Web Server.
commcell_username	no		Username
commcell_password	no		Password
method	yes	GET POST PUT DELETE	Web method to use to make the request
url	yes		The web URL or service to run the HTTP request on. Use "{0}" to autopopulate webconsole URL
payload	no		Dictionary consisting of JSON payload to pass to the HTTP Request

Returns

Name	Returned	Type	Description	Sample
response	success	dict	Response of the HTTP request	{'errorCode': 0, 'errorMessage': ''}

Examples

- name: "REQUEST"
  commvault.ansible.request:
    method: 'GET'
    url: '{0}/cvdrbackup/info'
  register: response

- name: "REQUEST_RESTART_SERVICES"
    commvault.ansible.request:
    method: 'POST'
    url: '{0}/services/action/restart'
    payload:
      "action": 2
      "client": 
        "clientName": "client"
      "services":
        "allServices": true

- name: "REQUEST"
  commvault.ansible.request:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    method: 'GET'
    url: '{0}/cvdrbackup/info'
  register: response

commvault.ansible.deployment.install_software

To perform Push Installation from the Commserve

Synopsis

This module performs a Fresh Push Installation to Client Machine from the CommCell commvault.ansible.deployment.install_software module can be used in playbooks to perform Push Installs to Clients

Options

Parameter	required	default	choices	comments
webserver_hostname	no			Hostname of the Web Server.
commcell_username	no			Username
commcell_password	no			Password
os_type	yes		windows unix	Client machine operating system category
client_computers	yes			List of Hostnames of the Client Computers to perform a Push installion
windows_package	no		ACTIVE_DIRECTORY CLOUD_APPS DOMINO_DATABASE EXCHANGE FILE_SYSTEM MEDIA_AGENT SHAREPOINT ORACLE POSTGRESQL SQLSERVER VIRTUAL_SERVER VSS_PROVIDER WEB_CONSOLE TEST_AUTOMATION PYTHON_SDK COMMSERVE_LITE CONTENT_ANALYZER	list of windows features to be installed
unix_packages	no		CASSANDRA CLOUD_APPS DOMINO_DATABASE FILE_SYSTEM FILE_SYSTEM_FOR_IBMI FILE_SYSTEM_FOR_OPEN_VMS MEDIA_AGENT ORACLE POSTGRESQL SAPHANA SQLSERVER VIRTUAL_SERVER TEST_AUTOMATION PYTHON_SDK CONTENT_ANALYZER	list of unix features to be installed
username	no			username of the machine to install features on
password	no			Password of the machine to install features on
install_path	no			Install to a specified path on the client
client_group_name	no			List of the client groups for the client
storage_policy_name	no			Storage policy for the default subclient
sw_cache_client	no			Remote Cache Client Name/ Over-riding Software Cache
ma_index_cache_loaction	no			Index Cache location of the Media Agent package
wait_for_job_completion	no	True		Will wait for Download Job to Complete

Returns

Name	Returned	Type	Description	Sample
job_id	success	str	Push Software Job ID	2016

Examples

# Run a Push Installation to the client from Commserver.

- name: "INSTALL_SOFTWARE/PUSH_INSTALL"
  commvault.ansible.deployment.install_software:
    os_type: "windows"
    client_computers:
      - hostname1.example.com
      - x.x.x.x
    windows_packages:
      - FILE_SYSTEM
      - PYTHON_SDK
    username: "domain\username"
    password: "password"
    client_group_name:
      - random_group1
      - random_group2
      - random_group3
    install_path: "D:\Random"
    sw_cache_client: "RemoteCacheClient1"
    wait_for_job_completion: False

- name: "INSTALL_SOFTWARE/PUSH_INSTALL_WINDOWS"
  commvault.ansible.deployment.install_software:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    os_type: "unix"
    client_computers:
      - hostname1.example.com
      - x.x.x.x
    windows_packages:
      - FILE_SYSTEM
      - PYTHON_SDK
    username: "domain\username"
    password: "password"
    client_group_name:
      - random_group1
      - random_group2
      - random_group3
    install_path: "D:\Random"
    sw_cache_client: "RemoteCacheClient1"
    wait_for_job_completion: True

- name: "INSTALL_SOFTWARE/PUSH_INSTALL_UNIX"
  commvault.ansible.deployment.install_software:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    os_type: "unix"
    client_computers:
      - hostname1.example.com
      - x.x.x.x
    unix_packages:
      - MEDIA_AGENT
      - FILE_SYSTEM
    username: "root"
    password: "password"
    client_group_name:
      - random_group1
      - random_group2
      - random_group3
    install_path: "/opt/commvault/ansibledeployment"
    ma_index_cache_location: "/opt/commvault/ma_index_cache"
    sw_cache_client: "RemoteCacheClient1"

notes: 
    Either Windows Packages can be provided or Unix Packages but never both together; 
    Cross platform(Windows & Unix) Push Installation not Supported

Notes

windows_package option required only for Windows Client Installations & None for Unix Client Installations
unix_packages option required only for Unix Client Installations & None for Windows Client Installations

commvault.ansible.deployment.download_software

To perform Download Software on Commserve

Synopsis

This module Downloads Media/Latest Payload from the Internet commvault.ansible.deployment.download_software module can be used in playbooks to perform Download Software on CS

Options

Parameter	required	default	choices	comments
webserver_hostname	no			Hostname of the Web Server.
commcell_username	no			Username
commcell_password	no			Password
download_option	no	LATEST_SERVICEPACK	LATEST_SERVICEPACK LATEST_HOTFIXES SERVICEPACK_AND_HOTFIXES	Download option to download software
os_list	no		WINDOWS_32 WINDOWS_64 UNIX_AIX UNIX_AIX32 UNIX_MAC UNIX_FREEBSD86 UNIX_FREEBSD64 UNIX_HP UNIX_LINUX86 UNIX_LINUX64 UNIX_S390 UNIX_S390_31 UNIX_PPC64 UNIX_SOLARIS86 UNIX_SOLARIS64 UNIX_SOLARIS_SPARC UNIX_SOLARIS_SPARC86 UNIX_LINUX64LE	list of windows/unix packages to be downloaded
service_pack	no			service pack to be downloaded
cu_number	no	0		maintenance release number
sync_cache	no	True		Download/Sync the Remote Cache
wait_for_job_completion	no	True		Will wait for Download Job to Complete

Returns

Name	Returned	Type	Description	Sample
job_id	success	str	Download Software Job ID	2016

Examples

# Run a Download Job on the Commserver.

- name: "DOWNLOAD_SOFTWARE"
  commvault.ansible.deployment.download_software:
    download_option: "LATEST_SERVICEPACK"
    os_list:
      - WINDOWS_64
      - UNIX_LINUX64
    sync_cache: False
    wait_for_job_completion: False

- name: "DOWNLOAD_SOFTWARE"
  commvault.ansible.deployment.download_software:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    download_option: "LATEST_SERVICEPACK" (or)  "LATEST_HOTFIXES"
    os_list:
      - WINDOWS_64
      - UNIX_LINUX64
    sync_cache: False

- name: "DOWNLOAD_SOFTWARE"
  commvault.ansible.deployment.download_software:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    download_option: "SERVICEPACK_AND_HOTFIXES"
    os_list:
      - WINDOWS_64
      - UNIX_LINUX64
    service_pack: 23
    cu_number: 2
    sync_cache: False
    wait_for_job_completion: False

Notes

{'Service_pack option required only with the Download Option': 'SERVICEPACK_AND_HOTFIXES'}

commvault.ansible.deployment.push_updates

To Push Updates to the Clients from Commserver

Synopsis

This module pushes latest Updates to client from CommCell commvault.ansible.deployment.push_updates module can be used in playbooks to perform Push Updates to Clients

Options

Parameter	required	default	comments
webserver_hostname	no		Hostname of the Web Server.
commcell_username	no		Username
commcell_password	no		Password
client_names	no		List of Client Names(Name on Commcell) to install service pack on
client_group_names	no		list of Client groups to install service pack on
update_all_client_computers	no	False	boolean to specify whether to install on all clients
update_all_client_computer_groups	no	False	boolean to specify whether to install on all clients groups
reboot_client	no	False	boolean to specify whether to reboot the client or not while installing updates
run_db_maintenance	no	True	boolean to specify whether to run rb maintenance or not
install_maintenance_release_only	no	False	boolean to specify whether to install only Maintenance Release or Not
wait_for_job_completion	no	True	Will wait for Download Job to Complete

Returns

Name	Returned	Type	Description	Sample
job_id	success	str	Push Updates Job ID	2016

Examples

# Run a File System Backup for default subclient of default backupset.

- name: "PUSH_UPDATES_TO_ALL_THE_CLIENTS"
  commvault.ansible.deployment.push_updates:
    update_all_client_computers: True
    reboot_client: False
    wait_for_job_completion: False

- name: "PUSH_UPDATES_TO_ALL_CLIENT_GROUPS"
  commvault.ansible.deployment.push_updates:
    client_names: 
      - clientname1
      - clientname2
    update_all_client_computers: True
    reboot_client: False

- name: "PUSH_UPDATES"
  commvault.ansible.deployment.push_updates:
    client_names: 
      - clientname1
      - clientname2
    client_group_names:
      - clientgroupname1
      - client_group_name2
    update_all_client_computers: False
    update_all_client_computer_groups: True
    reboot_client: False
    wait_for_job_completion: True

- name: "PUSH_UPDATES"
  commvault.ansible.deployment.push_updates:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    client_names: 
      - clientname1
      - clientname2
    client_group_names:
      - clientgroupname1
      - client_group_name2
    update_all_client_computers: False
    update_all_client_computer_groups: True
    reboot_client: False

commvault.ansible.file_servers.manage_content

To update the properties of a file server at subclient level.

Synopsis

commvault.ansible.file_servers.manage_content can be used to update the content, filters and exceptions of a File System subclient. keys for 'update' are 'content', 'filter_content', 'exception_content' & will ALWAYS OVERWRITE existing values.

Options

Parameter	required	choices	comments
webserver_hostname	no		Hostname of the Web Server.
commcell_username	no		Commcell username
commcell_password	no		Commcell password
client	yes		The name of the client.
backupset	no		The name of the backupset.
subclient	no		The name of the subclient.
update	yes	content filter_content exception_content	A dictionary of updates to make where update is a dictionary with key is property name & value is property value.

Examples

- name: Update a File System subclient's content and filter, session file would be used.
  commvault.ansible.file_servers.manage_content:
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    update:
        content:
            - C:\ANSIBLE_PATH1
            - C:\ANSIBLE_PATH2
        filter_content:
            - C:\ANSIBLE_PATH1\FILTER1
            - C:\ANSIBLE_PATH1\FILTER2      

- name: Update a File System subclient's content and filter.
  commvault.ansible.file_servers.manage_content:
    webserver_hostname: "web_server_hostname" 
    commcell_username: "user"  
    commcell_password: "password"
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    update:
        content:
            - C:\ANSIBLE_PATH1
            - C:\ANSIBLE_PATH2
        filter_content:
            - C:\ANSIBLE_PATH1\FILTER1
            - C:\ANSIBLE_PATH1\FILTER2

commvault.ansible.file_servers.backup

To perform backup of a file server subclient.

Synopsis

commvault.ansible.file_servers.backup can be used to perform file server backup operation.

Options

Parameter	required	default	choices	comments
webserver_hostname	no			Hostname of the Web Server.
commcell_username	no			Commcell username
commcell_password	no			Commcell password
client	yes			The name of the Client.
backupset	no	default backupset		The name of the backupset.
subclient	no	subclient named default.		The name of the subclient.
backup_level	no	Incremental	Full Incremental Differential Synthetic_full	Backup Level.
agent_type	no	File System	File System Linux File System	Agent Type.

Returns

Name	Returned	Type	Description	Sample
job_id	On success	str	Backup job ID	2016

Examples

- name: Run an incremental(default) File System Backup for default subclient of default backupset, session file would be used.
  commvault.ansible.file_servers.backup:
    client: "client_name"

- name: Run an incremental(default) File System Backup for subclient 'user_subclient' of backupset 'user_backupset', session file would be used.
  commvault.ansible.file_servers.backup:
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
        
- name: Run an incremental(default) File System Backup for default subclient of default backupset.
  commvault.ansible.file_servers.backup:
    webserver_hostname: "web_server_hostname" 
    commcell_username: "user"  
    commcell_password: "password"
    client: "client_name"

- name: Run an incremental(default) File System Backup for subclient 'user_subclient' of backupset 'user_backupset'.
  commvault.ansible.file_servers.backup:
    webserver_hostname: "web_server_hostname" 
    commcell_username: "user"  
    commcell_password: "password"
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"

- name: Run an incremental(default) File System Backup for subclient 'user_subclient' of backupset 'user_backupset'i with agent_type of Linux File System.
  commvault.ansible.file_servers.backup:
    webserver_hostname: "web_server_hostname"
    commcell_username: "user"
    commcell_password: "password"
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    agent_type: "Linux File System"

- name: Run a full File System Backup for subclient 'user_subclient' of backupset 'user_backupset' specifying 'backup_level' as Full.
  commvault.ansible.file_servers.backup:
    webserver_hostname: "web_server_hostname"
    commcell_username: "user"
    commcell_password: "password"
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    backup_level: "Full"

commvault.ansible.file_servers.manage_plan

To change the plan associated to the client, backupset or subclient.

Synopsis

commvault.ansible.file_servers.manage_plan can be used to change the server plan associated at the client, backupset or subclient level.

Options

Parameter	required	comments
webserver_hostname	no	Hostname of the Web Server.
commcell_username	no	Commcell username
commcell_password	no	Commcell password
client	yes	The name of the client.
plan	yes	The name of the server plan which needs to be associated to the entity.
backupset	no	The name of the backupset.
subclient	no	The name of the subclient.

Examples

- name: Associate a client to plan 'server plan', session file will be used.
  commvault.ansible.file_servers.manage_plan:
    client: "client_name"
    plan: "server plan"

- name: Associate a user created subclient to plan 'server plan'.
  commvault.ansible.file_servers.manage_plan:
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    plan: "server plan"
    
- name: Associate a user created subclient to plan 'server plan'.
  commvault.ansible.file_servers.manage_plan:
    webserver_hostname: "web_server_hostname"
    commcell_username: "user"
    commcell_password: "password"
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    plan: "server plan"
author:
- Commvault Systems Inc

commvault.ansible.file_servers.restore

To perform restore of a file server subclient.

Synopsis

commvault.ansible.file_servers.restore can be used to perform a file server restore operation.

Options

Parameter	required	default	choices	comments
webserver_hostname	no			Hostname of the Web Server.
commcell_username	no			Commcell username
commcell_password	no			Commcell password
client	yes			The name of the client.
backupset	no	default backupset		The name of the backupset.
subclient	no	subclient named 'default'.		The name of the subclient.
agent_type	no	File System	File System Linux File System	Agent Type.
content	yes			The path of the content that needs to be restored.
in_place	no	True	true false	Whether the content needs to be restored in place i.e. restored back to the source location.
destination_path	no			Destination path in case the content needs to be restored to another location.
unconditional_overwrite	no	True	true false	Specifies whether data needs to be overwritten at the destination if the file already exists.

Returns

Name	Returned	Type	Description	Sample
job_id	On success	str	Restore job ID	2017

Examples

- name: Run a File System Restore for default subclient of default backupset, session file will be used.
  commvault.ansible.file_servers.restore:
    client: "client_name"
    content: "C:\path\of\content"

- name: Run a File System Restore for subclient 'user_subclient' of backupset 'user_backupset', session file will be used.
  commvault.ansible.file_servers.restore:
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    content: "C:\path\of\content"

- name: Run a File System Restore for subclient 'user_subclient' of backupset 'user_backupset' and agent_type of Linux File System, session file will be used.
  commvault.ansible.file_servers.restore:
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    agent_type: "Linux File System"
    content: "C:\path\of\content"
    
- name: Run an In-Place File System Restore for subclient 'user_subclient' of backupset 'user_backupset'.
  commvault.ansible.file_servers.restore:
    webserver_hostname: "web_server_hostname"
    commcell_username: "user"
    commcell_password: "password"
    client: "client_name"
    backupset: "user_backupset"
    subclient: "user_subclient"
    content: "C:\path\of\content"
    in_place: "yes"

commvault.ansible.job.kill

kills the Job

Synopsis

This module kills the job commvault.ansible.job.kill module can be used in playbooks to kill the job

Options

Parameter	required	default	comments
webserver_hostname	no		Hostname of the Web Server.
commcell_username	no		Username
commcell_password	no		Password
job_id	yes		ID of the job
wait_for_job_to_kill	no	False	wait till job status is changed to Killed

Examples

# kills a particular Job

- name: "Kill Job"
  commvault.ansible.job.kill:
    job_id: 3

- name: "kill Job"
  commvault.ansible.job.kill:
    job_id: 7
    wait_for_job_to_kill: False

- name: "kill Job and Wait for kill Task to be completed"
  commvault.ansible.job.kill:
    job_id: 18
    wait_for_job_to_kill: True

- name: "kill Job"
  commvault.ansible.job.kill:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    job_id: 23

commvault.ansible.job.resume

Resumes the Job

Synopsis

This module resumes the job commvault.ansible.job.resume module can be used in playbooks to resume the job

Options

Parameter	required	default	comments
webserver_hostname	no		Hostname of the Web Server.
commcell_username	no		Username
commcell_password	no		Password
job_id	yes		ID of the job
wait_for_job_to_resume	no	False	wait till job status is changed to Running

Examples

# Resumes a particular Job

- name: "Resume Job"
  commvault.ansible.job.resume:
    job_id: 3

- name: "Resume Job"
  commvault.ansible.job.resume:
    job_id: 7
    wait_for_job_to_resume: False

- name: "Resume Job and Wait for Resume Task to be completed"
  commvault.ansible.job.resume:
    job_id: 18
    wait_for_job_to_resume: True

- name: "Resume Job"
  commvault.ansible.job.resume:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    job_id: 23

commvault.ansible.job.status

Checks the status of the Job

Synopsis

This module Checks the Job Status commvault.ansible.job.status module can be used in playbooks to check the job status

Options

Parameter	required	default	comments
webserver_hostname	no		Hostname of the Web Server.
commcell_username	no		Username
commcell_password	no		Password
job_id	yes		ID of the job
wait_for_job_completion	no	False	wait till job status is changed to Completed/Failed

Returns

Name	Returned	Type	Description	Sample
job_id		str	Status of the Job	Running/Completed

Examples

# Checks the status of the particular Job

- name: "Job Status"
  commvault.ansible.job.status:
    job_id: 3

- name: "Job Status"
  commvault.ansible.job.status:
    job_id: 7
    wait_for_job_completion: False

- name: "Wait for Job Completion and provide the Job Status"
  commvault.ansible.job.status:
    job_id: 18
    wait_for_job_completion: True

- name: "Job Status"
  commvault.ansible.job.status:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    job_id: 23

commvault.ansible.job.suspend

Suspends the Job

Synopsis

This module suspends the job commvault.ansible.job.suspend module can be used in playbooks to suspend the job

Options

Parameter	required	default	comments
webserver_hostname	no		Hostname of the Web Server.
commcell_username	no		Username
commcell_password	no		Password
job_id	yes		ID of the job
wait_for_job_to_suspend	no	False	wait until job status is changed to Suspended

Examples

# Suspends a particular Job

- name: "Suspend Job"
  commvault.ansible.job.suspend:
    job_id: 3

- name: "Suspend Job"
  commvault.ansible.job.suspend:
    job_id: 7
    wait_for_job_to_suspend: False

- name: "Suspend Job and Wait for Suspend Task to be completed"
  commvault.ansible.job.suspend:
    job_id: 18
    wait_for_job_to_suspend: True

- name: "Suspend Job"
  commvault.ansible.job.suspend:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    job_id: 23

commvault.ansible.plans.add

Creates a plan

Synopsis

This module creates a Plan in the CommCell

Options

Parameter	required	default	choices	comments
webserver_hostname	no			Hostname of the Web Server.
commcell_username	no			Commcell username
commcell_password	no			Commcell password
name	yes			The name of the plan.
storage_pool_name	yes			The name of the storage to use for the plan.
type	no	Server	Server Laptop ExchangeUser	The type of plan to create.
rpo_minutes	no	1440		The Recovery Point Objective time in minutes for the plan. Default is 1440 minutes (24 hours)

Returns

Name	Returned	Type	Description	Sample
name	Success	str	The name of the plan created	Plan 1

Examples

- name: Creating a plan
  commvault.ansible.plans.add:
    name: "Plan 1"
    storage_pool_name: "storage2"

- name: Creating a plan with 7 days RPO
  commvault.ansible.plans.add:
    name: "Plan 1"
    storage_pool_name: "storage2"
    rpo_minutes: 10080

- name: Creating a "Server" plan with 2 days RPO
  commvault.ansible.plans.add:
    name: "Plan 1"
    type: "Server"
    storage_pool_name: "storage2"
    type: "Server"
    rpo_minutes: 2880

- name: Creating a "Server" plan with 2 days RPO
  commvault.ansible.plans.add:
    webserver_hostname: "web_server_hostname" 
    commcell_username: "user"  
    commcell_password: "password"
    name: "Plan 1"
    type: "Server"
    storage_pool_name: "storage2"
    rpo_minutes: 2880

commvault.ansible.plans.delete

Deletes a plan

Synopsis

This module deletes a Plan in the CommCell

Options

Parameter	required	comments
webserver_hostname	no	Hostname of the Web Server.
commcell_username	no	Commcell username
commcell_password	no	Commcell password
name	yes	The name of the plan to delete.

Examples

- name: Deleting plan
  commvault.ansible.plans.delete:
    name: "Plan 1"

- name: Deleting plan
  commvault.ansible.plans.delete:
    webserver_hostname: "web_server_hostname" 
    commcell_username: "user"  
    commcell_password: "password"
    name: "Plan 1"

commvault.ansible.workflow.execute

Executes the workflow with the workflow name and inputs

Synopsis

This module executes the given Workflow along with it's inputs commvault.ansible.workflow.execute module can be used in playbooks to execute the Workflows on client from Commcell

Options

Parameter	required	default	comments
webserver_hostname	no		Hostname of the Web Server.
commcell_username	no		Username
commcell_password	no		Password
workflow_name	yes		Name of the Workflow
workflow_inputs	yes		Dictionary consisting of inputs to execute the workflow
hidden_workflow	no	False	Is the workflow hidden ?

Returns

Name	Returned	Type	Description	Sample
job_id	success	str	Relevant workflow job ID (-1 if N/A)	2016

Examples

# Executes the workflow on given Clients/ClientGroups with the workflow name as inputs

- name: "EXECUTE_WORKFLOW"
  commvault.ansible.workflow.execute:
    workflow_name: "Demo_CheckReadiness"
    workflow_inputs: 
        ClientGroupName: "client_group1"

- name: "EXECUTE_WORKFLOW"
  commvault.ansible.workflow.execute:
    workflow_name: "client check readiness"
    workflow_inputs: 
        input1_name: "input1_value"
        input2_name: "input2_value"
    hidden: True
    wait_for_job_completion: False

- name: "EXECUTE_WORKFLOW"
  commvault.ansible.workflow.execute:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    workflow_name: "client check readiness"
    workflow_inputs: 
        input1_name: "input1_value"
        input2_name: "input2_value"
    hidden: True

commvault.ansible.workflow.deploy

Deploys a workflow on the Commcell.

Synopsis

Deploys a workflow on the Commcell. commvault.ansible.workflow.deploy module can be used in playbooks to Deploys a workflow on the Commcell.

Options

Parameter	required	comments
webserver_hostname	no	Hostname of the Web Server.
commcell_username	no	Username
commcell_password	no	Password
workflow_name	yes	Name of the Workflow
workflow_engine	yes	name of the client to deploy the workflow on
workflow_xml_path	yes	path of the workflow xml file / XMl contents

Examples

# Deploys a workflow on the Commcell.

- name: "DEPLOY_WORKFLOW"
  commvault.ansible.workflow.deploy:
    workflow_name: "Demo_CheckReadiness"
    workflow_engine:  "TempClient"
    workflow_xml_path:  "C:\TempDir"

- name: "DEPLOY_WORKFLOW"
  commvault.ansible.workflow.deploy:
    workflow_name: "client check readiness"
    workflow_engine:  "TempClient"
    workflow_xml_path:  "C:\TempDir"

- name: "DEPLOY_WORKFLOW"
  commvault.ansible.workflow.deploy:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    workflow_name: "client check readiness"
    workflow_engine:  "TempClient"
    workflow_xml_path:  "C:\TempDir"

commvault.ansible.workflow.export

Exports the workflow to the directory location specified by the user.

Synopsis

Exports the workflow XML to the directory location specified by the user. commvault.ansible.workflow.export module can be used in playbooks to export the workflow to the directory location specified by the user.

Options

Parameter	required	comments
webserver_hostname	no	Hostname of the Web Server.
commcell_username	no	Username
commcell_password	no	Password
workflow_name	yes	Name of the Workflow
export_location	yes	Directory where the workflow would be exported

Examples

# Exports the workflow to the directory location specified by the user.

- name: "EXPORT_WORKFLOW"
  commvault.ansible.workflow.export:
    workflow_name: "Demo_CheckReadiness"
    export_location: "C:\TempDir"

- name: "EXPORT_WORKFLOW"
  commvault.ansible.workflow.export:
    workflow_name: "client check readiness"
    export_location: "C:\TempDir"

- name: "EXPORT_WORKFLOW"
  commvault.ansible.workflow.export:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    workflow_name: "client check readiness"
    export_location: "C:\TempDir"

commvault.ansible.workflow.import

Imports a workflow to the Commcell.

Synopsis

Imports a workflow to the Commcell. commvault.ansible.workflow.import module can be used in playbooks to import a workflow on the Commcell.

Options

Parameter	required	comments
webserver_hostname	no	Hostname of the Web Server.
commcell_username	no	Username
commcell_password	no	Password
workflow_name	yes	Name of the Workflow
workflow_xml_path	yes	path of the workflow xml file / XMl contents

Examples

# Imports a workflow to the Commcell.

- name: "IMPORT_WORKFLOW"
  commvault.ansible.workflow.import:
    workflow_xml_path:  "C:\TempDir"

- name: "IMPORT_WORKFLOW"
  commvault.ansible.workflow.import:
    workflow_xml_path:  "C:\TempDir"

- name: "IMPORT_WORKFLOW"
  commvault.ansible.workflow.import:
    webserver_hostname: "demo-CS-Name"
    commcell_username: "user"
    commcell_password: "CS-Password"
    workflow_xml_path:  "C:\TempDir"

commvault.ansible.storage.disk.detail

Gets details of a disk storage

Synopsis

This module gets details of a given disk storage

Options

Parameter	required	comments
webserver_hostname	no	Hostname of the Web Server.
commcell_username	no	Commcell username
commcell_password	no	Commcell password
name	yes	The name of the disk storage pool.

Returns

Name	Returned	Type	Description	Sample
detail	Success	dict	Details of the disk storage

Examples

- name: "Getting details of disk storage"
  commvault.ansible.storage.disk.detail:
    name: "storage2"

- name: "Getting details of disk storage"
  commvault.ansible.storage.disk.detail:
    webserver_hostname: "web_server_hostname" 
    commcell_username: "user"  
    commcell_password: "password"
    name: "storage2"

commvault.ansible.storage.disk.add

Creates a disk storage

Synopsis

This module creates a disk storage in the CommCell

Options

Parameter	required	comments
webserver_hostname	no	Hostname of the Web Server.
commcell_username	no	Commcell username
commcell_password	no	Commcell password
name	yes	The name of the disk storage pool.
media_agent	yes	The name of the media agent to create the disk storage for.
mount_path	yes	The path of the disk storage.
deduplication_db_path	yes	The path of the deduplication DB storage

Returns

Name	Returned	Type	Description	Sample
name	Success	str	The name of the disk storage created	storage2

Examples

- name: Creating disk storage
  commvault.ansible.storage.disk.add:
    name: "storage2"
    media_agent: "cv_mediaagent_1"
    mount_path: "D:\storage2"
    deduplication_db_path: "D:\ddb_path2"

- name: Creating disk storage
  commvault.ansible.storage.disk.add:
    webserver_hostname: "web_server_hostname" 
    commcell_username: "user"  
    commcell_password: "password"
    name: "storage2"
    media_agent: "cv_mediaagent_1"
    mount_path: "D:\storage2"
    deduplication_db_path: "D:\ddb_path2"

Questions/Comments/Suggestions

If you have any questions or comments, please contact us here. Also Check out our community for Automation incase of queries.

Name		Name	Last commit message	Last commit date
Latest commit History 20 Commits
meta		meta
plugins		plugins
roles		roles
LICENSE		LICENSE
MANIFEST.json		MANIFEST.json
README.md		README.md
galaxy.yml		galaxy.yml
requirements.txt		requirements.txt

License

Commvault/ansiblev2

Folders and files

Latest commit

History

Repository files navigation

Ansible Collection - commvault.ansible

Requirements

Install Instructions

Contribution Guidelines

Coding Considerations

Code of Conduct

License

About Commvault

Additional Roles

Documentation for the collection

Modules

commvault.ansible.login

Synopsis

Options

Returns

Examples

commvault.ansible.logout

Synopsis

Examples

commvault.ansible.request

Synopsis

Options

Returns

Examples

commvault.ansible.deployment.install_software

Synopsis

Options

Returns

Examples

Notes

commvault.ansible.deployment.download_software

Synopsis

Options

Returns

Examples

Notes

commvault.ansible.deployment.push_updates

Synopsis

Options

Returns

Examples

commvault.ansible.file_servers.manage_content

Synopsis

Options

Examples

commvault.ansible.file_servers.backup

Synopsis

Options

Returns

Examples

commvault.ansible.file_servers.manage_plan

Synopsis

Options

Examples

commvault.ansible.file_servers.restore

Synopsis

Options

Returns

Examples

commvault.ansible.job.kill

Synopsis

Options

Examples

commvault.ansible.job.resume

Synopsis

Options

Examples

commvault.ansible.job.status

Synopsis

Options

Returns

Examples

commvault.ansible.job.suspend

Synopsis

Packages