na_ontap_vscan_scanner_pool – NetApp ONTAP Vscan Scanner Pools Configuration — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# na_ontap_vscan_scanner_pool – NetApp ONTAP Vscan Scanner Pools Configuration

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Configure a Vscan Scanner Pool

## Requirements

The below requirements are needed on the host that executes this module.

- A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward
- Ansible 2.6
- Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’
- Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’
- To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
hostname string / required |  | The hostname or IP address of the ONTAP instance.
hostnames - |  | List of hostnames of Vscan servers which are allowed to connect to Data ONTAP
http_port integer |  | Override the default port (80 or 443) with this port
https boolean | Choices: no ← yes | Enable and disable https
ontapi integer |  | The ontap api version to use
password string / required |  | Password for the specified user. aliases: pass
privileged_users - |  | List of privileged usernames. Username must be in the form "domain-name\user-name"
scanner_policy - | Choices: primary secondary idle | The name of the Virus scanner Policy
scanner_pool - / required |  | the name of the virus scanner pool
state - | Choices: present ← absent | Whether a Vscan Scanner pool is present or not
username string / required |  | This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. aliases: user
validate_certs boolean | Choices: no yes ← | If set to `no`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates.
vserver - / required |  | the name of the data vserver to use.

## Notes

Note

- The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

## Examples

    - name: Create and enable Scanner pool
      na_ontap_vscan_scanner_pool:
        state: present
        username: '{{ netapp_username }}'
        password: '{{ netapp_password }}'
        hostname: '{{ netapp_hostname }}'
        vserver: carchi-vsim2
        hostnames: ['name', 'name2']
        privileged_users: ['sim.rtp.openeng.netapp.com\admin', 'sim.rtp.openeng.netapp.com\carchi']
        scanner_pool: Scanner1
        scanner_policy: primary

    - name: Delete a scanner pool
      na_ontap_vscan_scanner_pool:
        state: absent
        username: '{{ netapp_username }}'
        password: '{{ netapp_password }}'
        hostname: '{{ netapp_hostname }}'
        vserver: carchi-vsim2
        scanner_pool: Scanner1

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>

Hint

If you notice any issues in this documentation you can edit this document to improve it.