veeamhub.veeam.veeam_vbr_rest_credentials (2.2.1) — module

Add and Remove Veeam Backup & Replication Credentials.

| "added in version" 1.0.0 of veeamhub.veeam"

Authors: Markus Kraus (@vMarkusK)

preview | supported by community

Install collection

Install with ansible-galaxy collection install veeamhub.veeam:==2.2.1


Add to requirements.yml

  collections:
    - name: veeamhub.veeam
      version: 2.2.1

Description

Add and Remove Veeam Backup & Replication Credentials.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Test Veeam RestAPI Collection
  hosts: localhost
  tasks:
    - name: Test veeam_vbr_rest_credentials Create
      veeamhub.veeam.veeam_vbr_rest_credentials:
        server_name: "<FQDN/IP>"
        server_username: "<Username>"
        server_password: "<Password>"
        type: "Linux"
        username: "<Username>"
        password: "<Password>"
        description: "Created by Ansible RestAPI Module"
      register: create_cred
    - name: Debug Result
      ansible.builtin.debug:
        var: create_cred
    - name: Test veeam_vbr_credentials Delete
      veeamhub.veeam.veeam_vbr_rest_credentials:
        server_name: "<FQDN/IP>"
        server_username: "<Username>"
        server_password: "<Password>"
        id: "{{ create_cred.msg.id }}"
        state: absent
      register: delete_cred
    - name: Debug Result
      ansible.builtin.debug:
        var: delete_cred

Inputs

    
id:
    description: VBR Server credential ID
    required: false
    type: str

type:
    choices:
    - Windows
    - Linux
    - Standard
    default: Standard
    description:
    - Set to C(Windows) to create new windows credentials.
    - Set to C(Linux) to create new liniux credentials.
    - Set to C(Standard) to create new standard credentials.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Indicate desired state.
    type: str

password:
    description: VBR Server credential password
    required: false
    type: str

username:
    description: VBR Server credential username
    required: false
    type: str

description:
    description: VBR Server credential description
    required: false
    type: str

server_name:
    description: VBR Server Name or IP
    required: true
    type: str

server_port:
    default: 9419
    description: VBR RestAPI Sever Port
    required: false
    type: str

validate_certs:
    default: false
    description: Validate SSL certs.
    required: false
    type: bool

server_password:
    description: VBR Server password
    required: true
    type: str

server_username:
    description: VBR Server Username
    required: true
    type: str