Datasets:

vikp
/

clean_notebooks

Dataset card Data Studio Files Files and versions Community

Split (1)

train · 1.01M rows

code stringlengths 2.5k 150k	kind stringclasses 1 value
ansible openstack.cloud.floating_ip_info – Get information about floating ips openstack.cloud.floating\_ip\_info – Get information about floating ips ======================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.floating_ip_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get a generator of floating ips. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| The description of a floating IP. \| \| fixed\_ip\_address string \| \| The fixed IP address associated with a floating IP address. \| \| floating\_ip\_address string \| \| The IP address of a floating IP. \| \| floating\_network string \| \| The name or id of the network associated with a floating IP. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| port string \| \| The name or id of the port to which a floating IP is associated. \| \| project\_id string \| \| The ID of the project a floating IP is associated with. \| \| region\_name string \| \| Name of the region. \| \| router string \| \| The name or id of an associated router. \| \| status string \| Choices:* active * down \| The status of a floating IP, which can be ``ACTIVE``or ``DOWN``. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Getting all floating ips - openstack.cloud.floating_ip_info: register: fips # Getting fip by associated fixed IP address. - openstack.cloud.floating_ip_info: fixed_ip_address: 192.168.10.8 register: fip # Getting fip by associated router. - openstack.cloud.floating_ip_info: router: my-router register: fip ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| floating\_ips complex \| On Success. \| The floating ip objects list. \| \| \| created\_at string \| success \| Timestamp at which the floating IP was assigned. \| \| \| description string \| success \| The description of a floating IP. \| \| \| dns\_domain string \| success \| The DNS domain. \| \| \| dns\_name string \| success \| The DNS name. \| \| \| fixed\_ip\_address string \| success \| The fixed IP address associated with a floating IP address. \| \| \| floating\_ip\_address string \| success \| The IP address of a floating IP. \| \| \| floating\_network\_id string \| success \| The id of the network associated with a floating IP. \| \| \| id string \| success \| Id of the floating ip. \| \| \| name string \| success \| Name of the floating ip. \| \| \| port\_details string \| success \| The details of the port that this floating IP associates with. Present if ``fip-port-details`` extension is loaded. \| \| \| port\_id string \| success \| The port ID floating ip associated with. \| \| \| project\_id string \| success \| The ID of the project this floating IP is associated with. \| \| \| qos\_policy\_id string \| success \| The ID of the QoS policy attached to the floating IP. \| \| \| revision\_number string \| success \| Revision number. \| \| \| router\_id string \| success \| The id of the router floating ip associated with. \| \| \| status string \| success \| The status of a floating IP, which can be ``ACTIVE``or ``DOWN``. Can be 'ACTIVE' and 'DOWN'. \| \| \| subnet\_id string \| success \| The id of the subnet the floating ip associated with. \| \| \| tags string \| success \| List of tags. \| \| \| updated\_at string \| success \| Timestamp at which the floating IP was last updated. \| ### Authors * OpenStack Ansible SIG ansible Openstack.Cloud Openstack.Cloud =============== Collection version 1.5.1 Plugin Index ------------ These are the plugins in the openstack.cloud collection ### Inventory Plugins * [openstack](openstack_inventory#ansible-collections-openstack-cloud-openstack-inventory) – OpenStack inventory source ### Modules * [address\_scope](address_scope_module#ansible-collections-openstack-cloud-address-scope-module) – Create or delete address scopes from OpenStack * [auth](auth_module#ansible-collections-openstack-cloud-auth-module) – Retrieve an auth token * [baremetal\_inspect](baremetal_inspect_module#ansible-collections-openstack-cloud-baremetal-inspect-module) – Explicitly triggers baremetal node introspection in ironic. * [baremetal\_node](baremetal_node_module#ansible-collections-openstack-cloud-baremetal-node-module) – Create/Delete Bare Metal Resources from OpenStack * [baremetal\_node\_action](baremetal_node_action_module#ansible-collections-openstack-cloud-baremetal-node-action-module) – Activate/Deactivate Bare Metal Resources from OpenStack * [catalog\_service](catalog_service_module#ansible-collections-openstack-cloud-catalog-service-module) – Manage OpenStack Identity services * [coe\_cluster](coe_cluster_module#ansible-collections-openstack-cloud-coe-cluster-module) – Add/Remove COE cluster from OpenStack Cloud * [coe\_cluster\_template](coe_cluster_template_module#ansible-collections-openstack-cloud-coe-cluster-template-module) – Add/Remove COE cluster template from OpenStack Cloud * [compute\_flavor](compute_flavor_module#ansible-collections-openstack-cloud-compute-flavor-module) – Manage OpenStack compute flavors * [compute\_flavor\_info](compute_flavor_info_module#ansible-collections-openstack-cloud-compute-flavor-info-module) – Retrieve information about one or more flavors * [config](config_module#ansible-collections-openstack-cloud-config-module) – Get OpenStack Client config * [dns\_zone](dns_zone_module#ansible-collections-openstack-cloud-dns-zone-module) – Manage OpenStack DNS zones * [dns\_zone\_info](dns_zone_info_module#ansible-collections-openstack-cloud-dns-zone-info-module) – Getting information about dns zones * [endpoint](endpoint_module#ansible-collections-openstack-cloud-endpoint-module) – Manage OpenStack Identity service endpoints * [federation\_idp](federation_idp_module#ansible-collections-openstack-cloud-federation-idp-module) – manage a federation Identity Provider * [federation\_idp\_info](federation_idp_info_module#ansible-collections-openstack-cloud-federation-idp-info-module) – Get the information about the available federation identity providers * [federation\_mapping](federation_mapping_module#ansible-collections-openstack-cloud-federation-mapping-module) – Manage a federation mapping * [federation\_mapping\_info](federation_mapping_info_module#ansible-collections-openstack-cloud-federation-mapping-info-module) – Get the information about the available federation mappings * [floating\_ip](floating_ip_module#ansible-collections-openstack-cloud-floating-ip-module) – Add/Remove floating IP from an instance * [floating\_ip\_info](floating_ip_info_module#ansible-collections-openstack-cloud-floating-ip-info-module) – Get information about floating ips * [group\_assignment](group_assignment_module#ansible-collections-openstack-cloud-group-assignment-module) – Associate OpenStack Identity users and groups * [host\_aggregate](host_aggregate_module#ansible-collections-openstack-cloud-host-aggregate-module) – Manage OpenStack host aggregates * [identity\_domain](identity_domain_module#ansible-collections-openstack-cloud-identity-domain-module) – Manage OpenStack Identity Domains * [identity\_domain\_info](identity_domain_info_module#ansible-collections-openstack-cloud-identity-domain-info-module) – Retrieve information about one or more OpenStack domains * [identity\_group](identity_group_module#ansible-collections-openstack-cloud-identity-group-module) – Manage OpenStack Identity Groups * [identity\_group\_info](identity_group_info_module#ansible-collections-openstack-cloud-identity-group-info-module) – Retrieve info about one or more OpenStack groups * [identity\_role](identity_role_module#ansible-collections-openstack-cloud-identity-role-module) – Manage OpenStack Identity Roles * [identity\_role\_info](identity_role_info_module#ansible-collections-openstack-cloud-identity-role-info-module) – Retrive information about roles * [identity\_user](identity_user_module#ansible-collections-openstack-cloud-identity-user-module) – Manage OpenStack Identity Users * [identity\_user\_info](identity_user_info_module#ansible-collections-openstack-cloud-identity-user-info-module) – Retrieve information about one or more OpenStack users * [image](image_module#ansible-collections-openstack-cloud-image-module) – Add/Delete images from OpenStack Cloud * [image\_info](image_info_module#ansible-collections-openstack-cloud-image-info-module) – Retrieve information about an image within OpenStack. * [keypair](keypair_module#ansible-collections-openstack-cloud-keypair-module) – Add/Delete a keypair from OpenStack * [keypair\_info](keypair_info_module#ansible-collections-openstack-cloud-keypair-info-module) – Get information about keypairs from OpenStack * [keystone\_federation\_protocol](keystone_federation_protocol_module#ansible-collections-openstack-cloud-keystone-federation-protocol-module) – manage a federation Protocol * [keystone\_federation\_protocol\_info](keystone_federation_protocol_info_module#ansible-collections-openstack-cloud-keystone-federation-protocol-info-module) – get information about federation Protocols * [lb\_health\_monitor](lb_health_monitor_module#ansible-collections-openstack-cloud-lb-health-monitor-module) – Add/Delete a health m nonitor to a pool in the load balancing service from OpenStack Cloud * [lb\_listener](lb_listener_module#ansible-collections-openstack-cloud-lb-listener-module) – Add/Delete a listener for a load balancer from OpenStack Cloud * [lb\_member](lb_member_module#ansible-collections-openstack-cloud-lb-member-module) – Add/Delete a member for a pool in load balancer from OpenStack Cloud * [lb\_pool](lb_pool_module#ansible-collections-openstack-cloud-lb-pool-module) – Add/Delete a pool in the load balancing service from OpenStack Cloud * [loadbalancer](loadbalancer_module#ansible-collections-openstack-cloud-loadbalancer-module) – Add/Delete load balancer from OpenStack Cloud * [network](network_module#ansible-collections-openstack-cloud-network-module) – Creates/removes networks from OpenStack * [networks\_info](networks_info_module#ansible-collections-openstack-cloud-networks-info-module) – Retrieve information about one or more OpenStack networks. * [object](object_module#ansible-collections-openstack-cloud-object-module) – Create or Delete objects and containers from OpenStack * [object\_container](object_container_module#ansible-collections-openstack-cloud-object-container-module) – Manage Swift container. * [port](port_module#ansible-collections-openstack-cloud-port-module) – Add/Update/Delete ports from an OpenStack cloud. * [port\_info](port_info_module#ansible-collections-openstack-cloud-port-info-module) – Retrieve information about ports within OpenStack. * [project](project_module#ansible-collections-openstack-cloud-project-module) – Manage OpenStack Projects * [project\_access](project_access_module#ansible-collections-openstack-cloud-project-access-module) – Manage OpenStack compute flavors access * [project\_info](project_info_module#ansible-collections-openstack-cloud-project-info-module) – Retrieve information about one or more OpenStack projects * [quota](quota_module#ansible-collections-openstack-cloud-quota-module) – Manage OpenStack Quotas * [recordset](recordset_module#ansible-collections-openstack-cloud-recordset-module) – Manage OpenStack DNS recordsets * [role\_assignment](role_assignment_module#ansible-collections-openstack-cloud-role-assignment-module) – Associate OpenStack Identity users and roles * [router](router_module#ansible-collections-openstack-cloud-router-module) – Create or delete routers from OpenStack * [routers\_info](routers_info_module#ansible-collections-openstack-cloud-routers-info-module) – Retrieve information about one or more OpenStack routers. * [security\_group](security_group_module#ansible-collections-openstack-cloud-security-group-module) – Add/Delete security groups from an OpenStack cloud. * [security\_group\_info](security_group_info_module#ansible-collections-openstack-cloud-security-group-info-module) – Lists security groups * [security\_group\_rule](security_group_rule_module#ansible-collections-openstack-cloud-security-group-rule-module) – Add/Delete rule from an existing security group * [security\_group\_rule\_info](security_group_rule_info_module#ansible-collections-openstack-cloud-security-group-rule-info-module) – Querying security group rules * [server](server_module#ansible-collections-openstack-cloud-server-module) – Create/Delete Compute Instances from OpenStack * [server\_action](server_action_module#ansible-collections-openstack-cloud-server-action-module) – Perform actions on Compute Instances from OpenStack * [server\_group](server_group_module#ansible-collections-openstack-cloud-server-group-module) – Manage OpenStack server groups * [server\_info](server_info_module#ansible-collections-openstack-cloud-server-info-module) – Retrieve information about one or more compute instances * [server\_metadata](server_metadata_module#ansible-collections-openstack-cloud-server-metadata-module) – Add/Update/Delete Metadata in Compute Instances from OpenStack * [server\_volume](server_volume_module#ansible-collections-openstack-cloud-server-volume-module) – Attach/Detach Volumes from OpenStack VM’s * [stack](stack_module#ansible-collections-openstack-cloud-stack-module) – Add/Remove Heat Stack * [stack\_info](stack_info_module#ansible-collections-openstack-cloud-stack-info-module) – Retrive information about Heat stacks * [subnet](subnet_module#ansible-collections-openstack-cloud-subnet-module) – Add/Remove subnet to an OpenStack network * [subnets\_info](subnets_info_module#ansible-collections-openstack-cloud-subnets-info-module) – Retrieve information about one or more OpenStack subnets. * [volume](volume_module#ansible-collections-openstack-cloud-volume-module) – Create/Delete Cinder Volumes * [volume\_backup](volume_backup_module#ansible-collections-openstack-cloud-volume-backup-module) – Add/Delete Volume backup * [volume\_backup\_info](volume_backup_info_module#ansible-collections-openstack-cloud-volume-backup-info-module) – Get Backups * [volume\_info](volume_info_module#ansible-collections-openstack-cloud-volume-info-module) – Retrive information about volumes * [volume\_snapshot](volume_snapshot_module#ansible-collections-openstack-cloud-volume-snapshot-module) – Create/Delete Cinder Volume Snapshots * [volume\_snapshot\_info](volume_snapshot_info_module#ansible-collections-openstack-cloud-volume-snapshot-info-module) – Get volume snapshots See also List of [collections](../../index#list-of-collections) with docs hosted here. ansible openstack.cloud.lb_health_monitor – Add/Delete a health m nonitor to a pool in the load balancing service from OpenStack Cloud openstack.cloud.lb\_health\_monitor – Add/Delete a health m nonitor to a pool in the load balancing service from OpenStack Cloud ================================================================================================================================ Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.lb_health_monitor`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove a health monitor to/from a pool in the OpenStack load-balancer service. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| admin\_state\_up boolean \| Choices:* no * yes ← \| The admin state of the helath monitor true for up or false for down \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| delay string / required \| \| the interval, in seconds, between health checks. \| \| expected\_codes string \| Default:200 \| The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values A single value, such as 200 A list, such as 200, 202 A range, such as 200-204 \| \| http\_method string \| Choices:* GET ← * CONNECT * DELETE * HEAD * OPTIONS * PATCH * POST * PUT * TRACE \| The HTTP method that the health monitor uses for requests. One of CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, or TRACE. The default is GET. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| max\_retries string / required \| \| The number of successful checks before changing the operating status of the member to ONLINE. \| \| max\_retries\_down string \| Default:3 \| The number of allowed check failures before changing the operating status of the member to ERROR. A valid value is from 1 to 10. The default is 3. \| \| name string / required \| \| Name that has to be given to the health monitor \| \| pool string / required \| \| The pool name or id to monitor by the health monitor. \| \| region\_name string \| \| Name of the region. \| \| resp\_timeout integer / required \| \| The time, in seconds, after which a health check times out. Must be less than delay \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| type string \| Choices:* HTTP ← * HTTPS * PING * SCTP * TCP * TLS-HELLO * UDP-CONNECT \| One of HTTP, HTTPS, PING, SCTP, TCP, TLS-HELLO, or UDP-CONNECT. \| \| url\_path string \| Default:"/" \| The HTTP URL path of the request sent by the monitor to test the health of a backend member. Must be a string that begins with a forward slash (/). The default URL path is /. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` #Create a healtmonitor named healthmonitor01 with method HEAD url_path /status and expect code 200 - openstack.cloud.lb_health_monitor: auth: auth_url: "{{keystone_url}}" username: "{{username}}" password: "{{password}}" project_domain_name: "{{domain_name}}" user_domain_name: "{{domain_name}}" project_name: "{{project_name}}" wait: true admin_state_up: True expected_codes: '200' max_retries_down: '4' http_method: GET url_path: "/status" pool: '{{pool_id}}' name: 'healthmonitor01' delay: '10' max_retries: '3' resp_timeout: '5' state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| health\_monitor complex \| On success when `state=present` \| Dictionary describing the health monitor. \| \| \| admin\_state\_up boolean \| On success when `state=present` \| The administrative state of the resource. \| \| \| created\_at string \| On success when `state=present` \| The UTC date and timestamp when the resource was created. \| \| \| delay integer \| On success when `state=present` \| The time, in seconds, between sending probes to members. \| \| \| expected\_codes string \| On success when `state=present` \| The list of HTTP status codes expected in response from the member to declare it healthy. \| \| \| http\_method string \| On success when `state=present` \| The HTTP method that the health monitor uses for requests. \| \| \| id string \| On success when `state=present` \| The health monitor UUID. \| \| \| max\_retries string \| On success when `state=present` \| The number of successful checks before changing the operating status of the member to ONLINE. \| \| \| max\_retries\_down string \| On success when `state=present` \| The number of allowed check failures before changing the operating status of the member to ERROR. \| \| \| name string \| On success when `state=present` \| Human-readable name of the resource. \| \| \| operating\_status string \| On success when `state=present` \| The operating status of the resource. \| \| \| pool\_id string \| On success when `state=present` \| The id of the pool. \| \| \| project\_id string \| On success when `state=present` \| The ID of the project owning this resource. \| \| \| provisioning\_status string \| On success when `state=present` \| The provisioning status of the resource. \| \| \| timeout integer \| On success when `state=present` \| The maximum time, in seconds, that a monitor waits to connect before it times out. \| \| \| type string \| On success when `state=present` \| The type of health monitor. \| \| \| updated\_at string \| On success when `state=present` \| The UTC date and timestamp when the resource was last updated. \| \| \| url\_path string \| On success when `state=present` \| The HTTP URL path of the request sent by the monitor to test the health of a backend member. \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.volume_backup_info – Get Backups openstack.cloud.volume\_backup\_info – Get Backups ================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.volume_backup_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get Backup info from the Openstack cloud. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name of the Backup. \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| volume string \| \| Name of the volume. \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Get backups. - openstack.cloud.volume_backup_info: register: backup - openstack.cloud.volume_backup_info: name: my_fake_backup register: backup ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| volume\_backups list / elements=dictionary \| always. \| List of dictionaries describing volume backups. \| \| \| availability\_zone string \| success \| Backup availability zone. \| \| \| created\_at string \| success \| Backup creation time. \| \| \| description string \| success \| Backup desciption. \| \| \| id string \| success \| Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| \| is\_incremental boolean \| success \| Backup incremental property. \| \| \| metadata dictionary \| success \| Backup metadata. \| \| \| name string \| success \| Backup Name. \| \| \| snapshot\_id string \| success \| Snapshot ID. \| \| \| status string \| success \| Backup status. \| \| \| updated\_at string \| success \| Backup update time. \| \| \| volume\_id string \| success \| Volume ID. \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.security_group – Add/Delete security groups from an OpenStack cloud. openstack.cloud.security\_group – Add/Delete security groups from an OpenStack cloud. ===================================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.security_group`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add or Remove security groups from an OpenStack cloud. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Long description of the purpose of the security group \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Name that has to be given to the security group. This module requires that security group names be unique. \| \| project string \| \| Unique name or ID of the project. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a security group - openstack.cloud.security_group: cloud: mordred state: present name: foo description: security group for foo servers # Update the existing 'foo' security group description - openstack.cloud.security_group: cloud: mordred state: present name: foo description: updated description for the foo security group # Create a security group for a given project - openstack.cloud.security_group: cloud: mordred state: present name: foo project: myproj ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.volume_snapshot – Create/Delete Cinder Volume Snapshots openstack.cloud.volume\_snapshot – Create/Delete Cinder Volume Snapshots ======================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.volume_snapshot`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create or Delete cinder block storage volume snapshots Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| display\_description string \| \| String describing the snapshot aliases: description \| \| display\_name string / required \| \| Name of the snapshot aliases: name \| \| force boolean \| Choices:* no ← * yes \| Allows or disallows snapshot of a volume to be created when the volume is attached to an instance. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| volume string / required \| \| The volume name or id to create/delete the snapshot \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Creates a snapshot on volume 'test_volume' - name: create and delete snapshot hosts: localhost tasks: - name: create snapshot openstack.cloud.volume_snapshot: state: present cloud: mordred availability_zone: az2 display_name: test_snapshot volume: test_volume - name: delete snapshot openstack.cloud.volume_snapshot: state: absent cloud: mordred availability_zone: az2 display_name: test_snapshot volume: test_volume ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| snapshot dictionary \| success \| The snapshot instance after the change Sample: {'display\_name': 'test\_snapshot', 'id': '837aca54-c0ee-47a2-bf9a-35e1b4fdac0c', 'name': 'test\_snapshot', 'size': 2, 'status': 'available', 'volume\_id': 'ec646a7c-6a35-4857-b38b-808105a24be6'} \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.security_group_rule_info – Querying security group rules openstack.cloud.security\_group\_rule\_info – Querying security group rules =========================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.security_group_rule_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Querying security group rules Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Filter the list result by the human-readable description of the resource. \| \| direction string \| Choices:* egress * ingress \| Filter the security group rule list result by the direction in which the security group rule is applied. \| \| ethertype string \| Choices:* IPv4 * IPv6 \| Filter the security group rule list result by the ethertype of network traffic. The value must be IPv4 or IPv6. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| port\_range\_max integer \| \| Ending port \| \| port\_range\_min integer \| \| Starting port \| \| project string \| \| Unique name or ID of the project. \| \| protocol string \| Choices:* any * tcp * udp * icmp * 112 * 132 \| Filter the security group rule list result by the IP protocol. \| \| region\_name string \| \| Name of the region. \| \| remote\_group string \| \| Filter the security group rule list result by the name or ID of the remote group that associates with this security group rule. \| \| remote\_ip\_prefix string \| \| Source IP address(es) in CIDR notation (exclusive with remote\_group) \| \| revision\_number integer \| \| Filter the list result by the revision number of the resource. \| \| rule string \| \| Filter the list result by the ID of the security group rule. \| \| security\_group string \| \| Name or ID of the security group \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Get all security group rules - openstack.cloud.security_group_rule_info: cloud: "{{ cloud }}" register: sg # Filter security group rules for port 80 and name - openstack.cloud.security_group_rule_info: cloud: "{{ cloud }}" security_group: "{{ rule_name }}" protocol: tcp port_range_min: 80 port_range_max: 80 remote_ip_prefix: 0.0.0.0/0 # Filter for ICMP rules - openstack.cloud.security_group_rule_info: cloud: "{{ cloud }}" protocol: icmp ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| security\_group\_rules complex \| On Success. \| List of dictionaries describing security group rules. \| \| \| description string \| success \| Human-readable description of the resource. Sample: My description. \| \| \| direction string \| success \| The direction in which the security group rule is applied. Sample: egress \| \| \| ethertype string \| success \| One of IPv4 or IPv6. Sample: IPv4 \| \| \| id string \| success \| Unique rule UUID. \| \| \| port\_range\_max integer \| success \| The maximum port number in the range that is matched by the security group rule. Sample: 8000 \| \| \| port\_range\_min integer \| success \| The minimum port number in the range that is matched by the security group rule. Sample: 8000 \| \| \| project string \| success \| Unique ID of the project. Sample: 16d53a84a13b49529d2e2c3646691123 \| \| \| protocol string \| success \| The protocol that is matched by the security group rule. Sample: tcp \| \| \| remote\_ip\_prefix string \| success \| The remote IP prefix to be associated with this security group rule. Sample: 0.0.0.0/0 \| \| \| security\_group\_id string \| success \| The security group ID to associate with this security group rule. Sample: 729b9660-a20a-41fe-bae6-ed8fa7f69123 \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.recordset – Manage OpenStack DNS recordsets openstack.cloud.recordset – Manage OpenStack DNS recordsets =========================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.recordset`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OpenStack DNS recordsets. Recordsets can be created, deleted or updated. Only the records, description, and ttl values can be updated. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Description of the recordset \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Name of the recordset. It must be ended with name of dns zone. \| \| records list / elements=string \| \| List of recordset definitions. Required when state=present. \| \| recordset\_type string \| Choices:* a * aaaa * mx * cname * txt * ns * srv * ptr * caa \| Recordset type Required when state=present. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| ttl integer \| \| TTL (Time To Live) value in seconds \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| \| zone string / required \| \| Zone managing the recordset \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a recordset named "www.example.net." - openstack.cloud.recordset: cloud: mycloud state: present zone: example.net. name: www.example.net. recordset_type: "a" records: ['10.1.1.1'] description: test recordset ttl: 3600 # Update the TTL on existing "www.example.net." recordset - openstack.cloud.recordset: cloud: mycloud state: present zone: example.net. name: www.example.net. recordset_type: "a" records: ['10.1.1.1'] ttl: 7200 # Delete recordset named "www.example.net." - openstack.cloud.recordset: cloud: mycloud state: absent zone: example.net. name: www.example.net. ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| recordset complex \| On success when state is 'present'. \| Dictionary describing the recordset. \| \| \| description string \| success \| Recordset description Sample: Test description \| \| \| id string \| success \| Unique recordset ID Sample: c1c530a3-3619-46f3-b0f6-236927b2618c \| \| \| name string \| success \| Recordset name Sample: www.example.net. \| \| \| records list / elements=string \| success \| Recordset records Sample: ['10.0.0.1'] \| \| \| ttl integer \| success \| Zone TTL value Sample: 3600 \| \| \| type string \| success \| Recordset type Sample: A \| \| \| zone\_id string \| success \| Zone id Sample: 9508e177-41d8-434e-962c-6fe6ca880af7 \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.coe_cluster – Add/Remove COE cluster from OpenStack Cloud openstack.cloud.coe\_cluster – Add/Remove COE cluster from OpenStack Cloud ========================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.coe_cluster`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove COE cluster from the OpenStack Container Infra service. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| cluster\_template\_id string / required \| \| The template ID of cluster template. \| \| discovery\_url string \| \| Url used for cluster node discovery \| \| docker\_volume\_size integer \| \| The size in GB of the docker volume \| \| flavor\_id string \| \| The flavor of the minion node for this ClusterTemplate \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| keypair string \| \| Name of the keypair to use. \| \| labels raw \| \| One or more key/value pairs \| \| master\_count integer \| Default:1 \| The number of master nodes for this cluster \| \| master\_flavor\_id string \| \| The flavor of the master node for this ClusterTemplate \| \| name string / required \| \| Name that has to be given to the cluster template \| \| node\_count integer \| Default:1 \| The number of nodes for this cluster \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource. \| \| timeout integer \| Default:60 \| Timeout for creating the cluster in minutes. Default to 60 mins if not set \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a new Kubernetes cluster - openstack.cloud.coe_cluster: name: k8s cluster_template_id: k8s-ha keypair: mykey master_count: 3 node_count: 5 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cluster complex \| On success when state is 'present' \| Dictionary describing the cluster. \| \| \| api\_address string \| success \| Api address of cluster master node Sample: https://172.24.4.30:6443 \| \| \| cluster\_template\_id string \| success \| The cluster\_template UUID Sample: 7b1418c8-cea8-48fc-995d-52b66af9a9aa \| \| \| coe\_version string \| success \| Version of the COE software currently running in this cluster Sample: v1.11.1 \| \| \| container\_version string \| success \| Version of the container software. Example: docker version. Sample: 1.12.6 \| \| \| create\_timeout integer \| success \| Timeout for creating the cluster in minutes. Default to 60 if not set. Sample: 60 \| \| \| created\_at string \| success \| The time in UTC at which the cluster is created Sample: 2018-08-16T10:29:45+00:00 \| \| \| discovery\_url string \| success \| Url used for cluster node discovery Sample: https://discovery.etcd.io/a42ee38e7113f31f4d6324f24367aae5 \| \| \| faults dictionary \| success \| Fault info collected from the Heat resources of this cluster Sample: {'0': 'ResourceInError: resources[0].resources...'} \| \| \| flavor\_id string \| success \| The flavor of the minion node for this cluster Sample: c1.c1r1 \| \| \| id string \| success \| Unique UUID for this cluster Sample: 86246a4d-a16c-4a58-9e96ad7719fe0f9d \| \| \| keypair string \| success \| Name of the keypair to use. Sample: mykey \| \| \| labels dictionary \| success \| One or more key/value pairs Sample: {'key1': 'value1', 'key2': 'value2'} \| \| \| master\_addresses list / elements=string \| success \| IP addresses of cluster master nodes Sample: ['172.24.4.5'] \| \| \| master\_count integer \| success \| The number of master nodes for this cluster. Sample: 1 \| \| \| master\_flavor\_id string \| success \| The flavor of the master node for this cluster Sample: c1.c1r1 \| \| \| name string \| success \| Name that has to be given to the cluster Sample: k8scluster \| \| \| node\_addresses list / elements=string \| success \| IP addresses of cluster slave nodes Sample: ['172.24.4.8'] \| \| \| node\_count integer \| success \| The number of master nodes for this cluster. Sample: 1 \| \| \| stack\_id string \| success \| Stack id of the Heat stack Sample: 07767ec6-85f5-44cb-bd63-242a8e7f0d9d \| \| \| status string \| success \| Status of the cluster from the heat stack Sample: CREATE\_COMLETE \| \| \| status\_reason string \| success \| Status reason of the cluster from the heat stack Sample: Stack CREATE completed successfully \| \| \| updated\_at string \| success \| The time in UTC at which the cluster is updated Sample: 2018-08-16T10:39:25+00:00 \| \| id string \| On success when state is 'present' \| The cluster UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.lb_listener – Add/Delete a listener for a load balancer from OpenStack Cloud openstack.cloud.lb\_listener – Add/Delete a listener for a load balancer from OpenStack Cloud ============================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.lb_listener`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove a listener for a load balancer from the OpenStack load-balancer service. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| loadbalancer string / required \| \| The name or id of the load balancer that this listener belongs to. \| \| name string / required \| \| Name that has to be given to the listener \| \| protocol string \| Choices:* HTTP ← * HTTPS * TCP * TERMINATED\_HTTPS * UDP * SCTP \| The protocol for the listener. \| \| protocol\_port integer \| Default:80 \| The protocol port number for the listener. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| The amount of time the module should wait for the load balancer to get into ACTIVE state. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the load balancer to be ACTIVE. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a listener, wait for the loadbalancer to be active. - openstack.cloud.lb_listener: cloud: mycloud endpoint_type: admin state: present name: test-listener loadbalancer: test-loadbalancer protocol: HTTP protocol_port: 8080 # Create a listener, do not wait for the loadbalancer to be active. - openstack.cloud.lb_listener: cloud: mycloud endpoint_type: admin state: present name: test-listener loadbalancer: test-loadbalancer protocol: HTTP protocol_port: 8080 wait: no # Delete a listener - openstack.cloud.lb_listener: cloud: mycloud endpoint_type: admin state: absent name: test-listener loadbalancer: test-loadbalancer ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| On success when state is 'present' \| The listener UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| listener complex \| On success when state is 'present' \| Dictionary describing the listener. \| \| \| description string \| success \| The listener description. Sample: description \| \| \| id string \| success \| Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| \| is\_admin\_state\_up boolean \| success \| The administrative state of the listener. Sample: True \| \| \| load\_balancer\_id string \| success \| The load balancer UUID this listener belongs to. Sample: b32eef7e-d2a6-4ea4-a301-60a873f89b3b \| \| \| loadbalancers list / elements=string \| success \| A list of load balancer IDs.. Sample: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}] \| \| \| name string \| success \| Name given to the listener. Sample: test \| \| \| operating\_status string \| success \| The operating status of the listener. Sample: ONLINE \| \| \| protocol string \| success \| The protocol for the listener. Sample: HTTP \| \| \| protocol\_port integer \| success \| The protocol port number for the listener. Sample: 80 \| \| \| provisioning\_status string \| success \| The provisioning status of the listener. Sample: ACTIVE \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.auth – Retrieve an auth token openstack.cloud.auth – Retrieve an auth token ============================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.auth`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve an auth token from an OpenStack Cloud Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Authenticate to the cloud and retrieve the service catalog openstack.cloud.auth: cloud: rax-dfw - name: Show service catalog debug: var: service_catalog ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| auth\_token string \| success \| Openstack API Auth Token \| \| service\_catalog dictionary \| success \| A dictionary of available API endpoints \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.federation_mapping_info – Get the information about the available federation mappings openstack.cloud.federation\_mapping\_info – Get the information about the available federation mappings ======================================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.federation_mapping_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Fetch a federation mapping. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk >= 0.12.0 * openstacksdk >= 0.44 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| The name of the mapping to fetch. If name is specified, the module will return failed if the mapping doesn't exist. aliases: id \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Fetch a specific mapping openstack.cloud.federation_mapping_info: cloud: example_cloud name: example_mapping - name: Fetch all mappings openstack.cloud.federation_mapping_info: cloud: example_cloud ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.coe_cluster_template – Add/Remove COE cluster template from OpenStack Cloud openstack.cloud.coe\_cluster\_template – Add/Remove COE cluster template from OpenStack Cloud ============================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.coe_cluster_template`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove COE cluster template from the OpenStack Container Infra service. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| coe string / required \| Choices:* kubernetes * swarm * mesos \| The Container Orchestration Engine for this clustertemplate \| \| dns\_nameserver string \| Default:"8.8.8.8" \| The DNS nameserver address \| \| docker\_storage\_driver string \| Choices:* devicemapper * overlay * overlay2 \| Docker storage driver \| \| docker\_volume\_size integer \| \| The size in GB of the docker volume \| \| external\_network\_id string \| \| The external network to attach to the Cluster \| \| fixed\_network string \| \| The fixed network name to attach to the Cluster \| \| fixed\_subnet string \| \| The fixed subnet name to attach to the Cluster \| \| flavor\_id string \| \| The flavor of the minion node for this ClusterTemplate \| \| floating\_ip\_enabled boolean \| Choices:* no * yes ← \| Indicates whether created clusters should have a floating ip or not \| \| http\_proxy string \| \| Address of a proxy that will receive all HTTP requests and relay them The format is a URL including a port number \| \| https\_proxy string \| \| Address of a proxy that will receive all HTTPS requests and relay them. The format is a URL including a port number \| \| image\_id string / required \| \| Image id the cluster will be based on \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| keypair\_id string \| \| Name or ID of the keypair to use. \| \| labels raw \| \| One or more key/value pairs \| \| master\_flavor\_id string \| \| The flavor of the master node for this ClusterTemplate \| \| master\_lb\_enabled boolean \| Choices:* no ← * yes \| Indicates whether created clusters should have a load balancer for master nodes or not \| \| name string / required \| \| Name that has to be given to the cluster template \| \| network\_driver string \| Choices:* flannel * calico * docker \| The name of the driver used for instantiating container networks \| \| no\_proxy string \| \| A comma separated list of IPs for which proxies should not be used in the cluster \| \| public boolean \| Choices:* no ← * yes \| Indicates whether the ClusterTemplate is public or not \| \| region\_name string \| \| Name of the region. \| \| registry\_enabled boolean \| Choices:* no ← * yes \| Indicates whether the docker registry is enabled \| \| server\_type string \| Choices:* vm ← * bm \| Server type for this ClusterTemplate \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| tls\_disabled boolean \| Choices:* no ← * yes \| Indicates whether the TLS should be disabled \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| volume\_driver string \| Choices:* cinder * rexray \| The name of the driver used for instantiating container volumes \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a new Kubernetes cluster template - openstack.cloud.coe_cluster_template: name: k8s coe: kubernetes keypair_id: mykey image_id: 2a8c9888-9054-4b06-a1ca-2bb61f9adb72 public: no ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cluster\_template complex \| On success when state is 'present' \| Dictionary describing the template. \| \| \| coe string \| success \| The Container Orchestration Engine for this clustertemplate Sample: kubernetes \| \| \| dns\_nameserver string \| success \| The DNS nameserver address Sample: 8.8.8.8 \| \| \| docker\_storage\_driver string \| success \| Docker storage driver Sample: devicemapper \| \| \| docker\_volume\_size integer \| success \| The size in GB of the docker volume Sample: 5 \| \| \| external\_network\_id string \| success \| The external network to attach to the Cluster Sample: public \| \| \| fixed\_network string \| success \| The fixed network name to attach to the Cluster Sample: 07767ec6-85f5-44cb-bd63-242a8e7f0d9d \| \| \| fixed\_subnet string \| success \| The fixed subnet name to attach to the Cluster Sample: 05567ec6-85f5-44cb-bd63-242a8e7f0d9d \| \| \| flavor\_id string \| success \| The flavor of the minion node for this ClusterTemplate Sample: c1.c1r1 \| \| \| floating\_ip\_enabled boolean \| success \| Indicates whether created clusters should have a floating ip or not Sample: True \| \| \| http\_proxy string \| success \| Address of a proxy that will receive all HTTP requests and relay them The format is a URL including a port number Sample: http://10.0.0.11:9090 \| \| \| https\_proxy string \| success \| Address of a proxy that will receive all HTTPS requests and relay them. The format is a URL including a port number Sample: https://10.0.0.10:8443 \| \| \| image\_id string \| success \| Image id the cluster will be based on Sample: 05567ec6-85f5-44cb-bd63-242a8e7f0e9d \| \| \| keypair\_id string \| success \| Name or ID of the keypair to use. Sample: mykey \| \| \| labels dictionary \| success \| One or more key/value pairs Sample: {'key1': 'value1', 'key2': 'value2'} \| \| \| master\_flavor\_id string \| success \| The flavor of the master node for this ClusterTemplate Sample: c1.c1r1 \| \| \| master\_lb\_enabled boolean \| success \| Indicates whether created clusters should have a load balancer for master nodes or not Sample: True \| \| \| name string \| success \| Name that has to be given to the cluster template Sample: k8scluster \| \| \| network\_driver string \| success \| The name of the driver used for instantiating container networks Sample: calico \| \| \| no\_proxy string \| success \| A comma separated list of IPs for which proxies should not be used in the cluster Sample: 10.0.0.4,10.0.0.5 \| \| \| public boolean \| success \| Indicates whether the ClusterTemplate is public or not \| \| \| registry\_enabled boolean \| success \| Indicates whether the docker registry is enabled \| \| \| server\_type string \| success \| Server type for this ClusterTemplate Sample: vm \| \| \| tls\_disabled boolean \| success \| Indicates whether the TLS should be disabled \| \| \| volume\_driver string \| success \| The name of the driver used for instantiating container volumes Sample: cinder \| \| id string \| On success when state is 'present' \| The cluster UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.endpoint – Manage OpenStack Identity service endpoints openstack.cloud.endpoint – Manage OpenStack Identity service endpoints ====================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.endpoint`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update, or delete OpenStack Identity service endpoints. If a service with the same combination of service, interface and region exist, the url and state (`present` or `absent`) will be updated. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk >= 0.12.0 * openstacksdk >= 0.13.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| enabled boolean \| Choices:* no * yes ← \| Is the service enabled. \| \| endpoint\_interface string / required \| Choices:* admin * public * internal \| Interface of the service. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| region string \| \| Region that the service belongs to. Note that region\_name is used for authentication. \| \| region\_name string \| \| Name of the region. \| \| service string / required \| \| Name or id of the service. \| \| state string \| Choices:* present ← * absent \| Should the resource be `present` or `absent`. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| url string / required \| \| URL of the service. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Create a service for glance openstack.cloud.endpoint: cloud: mycloud service: glance endpoint_interface: public url: http://controller:9292 region: RegionOne state: present - name: Delete a service for nova openstack.cloud.endpoint: cloud: mycloud service: nova endpoint_interface: public region: RegionOne state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| endpoint complex \| On success when state is `present` \| Dictionary describing the endpoint. \| \| \| enabled boolean \| success \| Service status. Sample: True \| \| \| id string \| success \| Endpoint ID. Sample: 3292f020780b4d5baf27ff7e1d224c44 \| \| \| interface string \| success \| Endpoint Interface. Sample: public \| \| \| region string \| success \| Region Name. Sample: RegionOne \| \| \| service\_id string \| success \| Service ID. Sample: b91f1318f735494a825a55388ee118f3 \| \| \| url string \| success \| Service URL. Sample: http://controller:9292 \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.lb_member – Add/Delete a member for a pool in load balancer from OpenStack Cloud openstack.cloud.lb\_member – Add/Delete a member for a pool in load balancer from OpenStack Cloud ================================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.lb_member`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove a member for a pool from the OpenStack load-balancer service. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| The IP address of the member. \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Name that has to be given to the member \| \| pool string / required \| \| The name or id of the pool that this member belongs to. \| \| protocol\_port integer \| Default:80 \| The protocol port number for the member. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| subnet\_id string \| \| The subnet ID the member service is accessible from. \| \| timeout integer \| Default:180 \| The amount of time the module should wait for the load balancer to get into ACTIVE state. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the load balancer to be ACTIVE. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a member, wait for the member to be created. - openstack.cloud.lb_member: cloud: mycloud endpoint_type: admin state: present name: test-member pool: test-pool address: 192.168.10.3 protocol_port: 8080 # Delete a listener - openstack.cloud.lb_member: cloud: mycloud endpoint_type: admin state: absent name: test-member pool: test-pool ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| On success when state is 'present' \| The member UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| member complex \| On success when state is 'present' \| Dictionary describing the member. \| \| \| address string \| success \| The IP address of the backend member server. Sample: 192.168.2.10 \| \| \| description string \| success \| The member description. Sample: description \| \| \| id string \| success \| Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| \| is\_admin\_state\_up boolean \| success \| The administrative state of the member. Sample: True \| \| \| name string \| success \| Name given to the member. Sample: test \| \| \| operating\_status string \| success \| The operating status of the member. Sample: ONLINE \| \| \| protocol\_port integer \| success \| The protocol port number for the member. Sample: 80 \| \| \| provisioning\_status string \| success \| The provisioning status of the member. Sample: ACTIVE \| \| \| subnet\_id string \| success \| The subnet ID the member service is accessible from. Sample: 489247fa-9c25-11e8-9679-00224d6b7bc1 \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.server_volume – Attach/Detach Volumes from OpenStack VM’s openstack.cloud.server\_volume – Attach/Detach Volumes from OpenStack VM’s ========================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.server_volume`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Attach or Detach volumes from OpenStack VM’s Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| device string \| \| Device you want to attach. Defaults to auto finding a device name. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| region\_name string \| \| Name of the region. \| \| server string / required \| \| Name or ID of server you want to attach a volume to \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| volume string / required \| \| Name or id of volume you want to attach to a server \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Attaches a volume to a compute host - name: attach a volume hosts: localhost tasks: - name: attach volume to host openstack.cloud.server_volume: state: present cloud: mordred server: Mysql-server volume: mysql-data device: /dev/vdb ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.identity_domain_info – Retrieve information about one or more OpenStack domains openstack.cloud.identity\_domain\_info – Retrieve information about one or more OpenStack domains ================================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.identity_domain_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve information about a one or more OpenStack domains * This module was called `openstack.cloud.identity_domain_facts` before Ansible 2.9, returning `ansible_facts`. Note that the [openstack.cloud.identity\_domain\_info](#ansible-collections-openstack-cloud-identity-domain-info-module) module no longer returns `ansible_facts`! Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| filters dictionary \| \| A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name or ID of the domain \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Gather information about previously created domain - openstack.cloud.identity_domain_info: cloud: awesomecloud register: result - debug: msg: "{{ result.openstack_domains }}" # Gather information about a previously created domain by name - openstack.cloud.identity_domain_info: cloud: awesomecloud name: demodomain register: result - debug: msg: "{{ result.openstack_domains }}" # Gather information about a previously created domain with filter - openstack.cloud.identity_domain_info: cloud: awesomecloud name: demodomain filters: enabled: false register: result - debug: msg: "{{ result.openstack_domains }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_domains complex \| always, but can be null \| has all the OpenStack information about domains \| \| \| description string \| success \| Description of the domain. \| \| \| enabled boolean \| success \| Flag to indicate if the domain is enabled. \| \| \| id string \| success \| Unique UUID. \| \| \| name string \| success \| Name given to the domain. \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.project – Manage OpenStack Projects openstack.cloud.project – Manage OpenStack Projects =================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.project`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OpenStack Projects. Projects can be created, updated or deleted using this module. A project will be updated if name matches an existing project and state is present. The value for name cannot be updated without deleting and re-creating the project. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Description for the project \| \| domain\_id string \| \| Domain id to create the project in if the cloud supports domains. aliases: domain \| \| enabled boolean \| Choices:* no * yes ← \| Is the project enabled \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Name for the project \| \| properties dictionary \| \| Additional properties to be associated with this project. Requires openstacksdk>0.45. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a project - openstack.cloud.project: cloud: mycloud endpoint_type: admin state: present name: demoproject description: demodescription domain_id: demoid enabled: True properties: internal_alias: demo_project # Delete a project - openstack.cloud.project: cloud: mycloud endpoint_type: admin state: absent name: demoproject ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| project complex \| On success when state is 'present' \| Dictionary describing the project. \| \| \| description string \| success \| Project description Sample: demodescription \| \| \| enabled boolean \| success \| Boolean to indicate if project is enabled Sample: True \| \| \| id string \| success \| Project ID Sample: f59382db809c43139982ca4189404650 \| \| \| name string \| success \| Project name Sample: demoproject \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.object – Create or Delete objects and containers from OpenStack openstack.cloud.object – Create or Delete objects and containers from OpenStack =============================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.object`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or Delete objects and containers from OpenStack Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| container string / required \| \| The name of the container in which to create the object \| \| container\_access string \| Choices:* private ← * public \| desired container access level. \| \| filename string \| \| Path to local file to be uploaded. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name to be give to the object. If omitted, operations will be on the entire container \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: "Create a object named 'fstab' in the 'config' container" openstack.cloud.object: cloud: mordred state: present name: fstab container: config filename: /etc/fstab - name: Delete a container called config and all of its contents openstack.cloud.object: cloud: rax-iad state: absent container: config ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.identity_group_info – Retrieve info about one or more OpenStack groups openstack.cloud.identity\_group\_info – Retrieve info about one or more OpenStack groups ======================================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.identity_group_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve info about a one or more OpenStack groups. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| domain string \| \| Name or ID of the domain containing the group if the cloud supports domains \| \| filters dictionary \| \| A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name or ID of the group. \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Gather info about previously created groups - name: gather info hosts: localhost tasks: - name: Gather info about previously created groups openstack.cloud.identity_group_info: cloud: awesomecloud register: openstack_groups - debug: var: openstack_groups # Gather info about a previously created group by name - name: gather info hosts: localhost tasks: - name: Gather info about a previously created group by name openstack.cloud.identity_group_info: cloud: awesomecloud name: demogroup register: openstack_groups - debug: var: openstack_groups # Gather info about a previously created group in a specific domain - name: gather info hosts: localhost tasks: - name: Gather info about a previously created group in a specific domain openstack.cloud.identity_group_info: cloud: awesomecloud name: demogroup domain: admindomain register: openstack_groups - debug: var: openstack_groups # Gather info about a previously created group in a specific domain with filter - name: gather info hosts: localhost tasks: - name: Gather info about a previously created group in a specific domain with filter openstack.cloud.identity_group_info: cloud: awesomecloud name: demogroup domain: admindomain filters: enabled: False register: openstack_groups - debug: var: openstack_groups ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_groups complex \| always, but can be null \| Dictionary describing all the matching groups. \| \| \| description string \| success \| Description of the group. \| \| \| domain\_id boolean \| success \| Domain ID containing the group (keystone v3 clouds only) \| \| \| id string \| success \| Unique UUID. \| \| \| name string \| success \| Name given to the group. \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.stack_info – Retrive information about Heat stacks openstack.cloud.stack\_info – Retrive information about Heat stacks =================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.stack_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get information about Heat stack in openstack Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name of the stack as a string. \| \| owner\_id string \| \| Owner (parent) of the stack to be used as a filter \| \| project\_id string \| \| Project ID to be used as filter \| \| region\_name string \| \| Name of the region. \| \| status string \| \| Value of the status of the stack so that you can filter on "available" for example \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Get backups. - openstack.cloud.stack_info: register: stack - openstack.cloud.stack_info: name: my_stack register: stack ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| stacks list / elements=dictionary \| always. \| List of dictionaries describing stacks. \| \| \| id string \| success \| Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| \| status string \| success \| Stack status. \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.address_scope – Create or delete address scopes from OpenStack openstack.cloud.address\_scope – Create or delete address scopes from OpenStack =============================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.address_scope`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create or Delete address scopes from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| extra\_specs dictionary \| Default:{} \| Dictionary with extra key/value pairs passed to the API \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| ip\_version string \| Choices:* 4 * 6 Default:4 \| The IP version of the subnet 4 or 6 \| \| name string / required \| \| Name to be give to the address scope \| \| project string \| \| Unique name or ID of the project. \| \| region\_name string \| \| Name of the region. \| \| shared boolean \| Choices:* no ← * yes \| Whether this address scope is shared or not. \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create an IPv4 address scope. - openstack.cloud.address_scope: cloud: mycloud state: present name: my_adress_scope # Create a shared IPv6 address scope for a given project. - openstack.cloud.address_scope: cloud: mycloud state: present ip_version: 6 name: ipv6_address_scope project: myproj # Delete address scope. - openstack.cloud.address_scope: cloud: mycloud state: absent name: my_adress_scope ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| address\_scope complex \| On success when state is 'present' \| Dictionary describing the address scope. \| \| \| id string \| success \| Address Scope ID. Sample: 474acfe5-be34-494c-b339-50f06aa143e4 \| \| \| ip\_version string \| success \| The IP version of the subnet 4 or 6. Sample: 4 \| \| \| is\_shared boolean \| success \| Indicates whether this address scope is shared across all tenants. \| \| \| name string \| success \| Address Scope name. Sample: my\_address\_scope \| \| \| tenant\_id string \| success \| The tenant ID. Sample: 861174b82b43463c9edc5202aadc60ef \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.config – Get OpenStack Client config openstack.cloud.config – Get OpenStack Client config ==================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.config`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Get openstack client config data from clouds.yaml or environment Requirements ------------ The below requirements are needed on the host that executes this module. * python >= 3.6 * openstacksdk Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| clouds list / elements=string \| Default:[] \| List of clouds to limit the return list to. No value means return information on all configured clouds \| Notes ----- Note * Facts are placed in the `openstack.clouds` variable. Examples -------- ``` - name: Get list of clouds that do not support security groups openstack.cloud.config: - debug: var: "{{ item }}" with_items: "{{ openstack.clouds \| rejectattr('secgroup_source', 'none') \| list }}" - name: Get the information back just about the mordred cloud openstack.cloud.config: clouds: - mordred ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.server_info – Retrieve information about one or more compute instances openstack.cloud.server\_info – Retrieve information about one or more compute instances ======================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.server_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Retrieve information about server instances from OpenStack. * This module was called `os_server_facts` before Ansible 2.9, returning `ansible_facts`. Note that the [openstack.cloud.server\_info](#ansible-collections-openstack-cloud-server-info-module) module no longer returns `ansible_facts`! Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| all\_projects boolean \| Choices:* no ← * yes \| Whether to list servers from all projects or just the current auth scoped project. \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| detailed boolean \| Choices:* no ← * yes \| when true, return additional detail about servers at the expense of additional API calls. \| \| filters dictionary \| \| restrict results to servers matching a dictionary of filters \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| region\_name string \| \| Name of the region. \| \| server string \| \| restrict results to servers with names or UUID matching this glob expression (e.g., <web\>). \| \| timeout* integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The result contains a list of servers. * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Gather information about all servers named <web> that are in an active state: - openstack.cloud.server_info: cloud: rax-dfw server: web filters: vm_state: active register: result - debug: msg: "{{ result.openstack_servers }}" ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.security_group_rule – Add/Delete rule from an existing security group openstack.cloud.security\_group\_rule – Add/Delete rule from an existing security group ======================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.security_group_rule`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove rule from an existing security group Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| direction string \| Choices:* egress * ingress ← \| The direction in which the security group rule is applied. Not all providers support egress. \| \| ethertype string \| Choices:* IPv4 ← * IPv6 \| Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. Not all providers support IPv6. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| port\_range\_max integer \| \| Ending port \| \| port\_range\_min integer \| \| Starting port \| \| project string \| \| Unique name or ID of the project. \| \| protocol string \| \| IP protocols ANY TCP UDP ICMP and others, also number in range 0-255 \| \| region\_name string \| \| Name of the region. \| \| remote\_group string \| \| Name or ID of the Security group to link (exclusive with remote\_ip\_prefix) \| \| remote\_ip\_prefix string \| \| Source IP address(es) in CIDR notation (exclusive with remote\_group) \| \| security\_group string / required \| \| Name or ID of the security group \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a security group rule - openstack.cloud.security_group_rule: cloud: mordred security_group: foo protocol: tcp port_range_min: 80 port_range_max: 80 remote_ip_prefix: 0.0.0.0/0 # Create a security group rule for ping - openstack.cloud.security_group_rule: cloud: mordred security_group: foo protocol: icmp remote_ip_prefix: 0.0.0.0/0 # Another way to create the ping rule - openstack.cloud.security_group_rule: cloud: mordred security_group: foo protocol: icmp port_range_min: -1 port_range_max: -1 remote_ip_prefix: 0.0.0.0/0 # Create a TCP rule covering all ports - openstack.cloud.security_group_rule: cloud: mordred security_group: foo protocol: tcp port_range_min: 1 port_range_max: 65535 remote_ip_prefix: 0.0.0.0/0 # Another way to create the TCP rule above (defaults to all ports) - openstack.cloud.security_group_rule: cloud: mordred security_group: foo protocol: tcp remote_ip_prefix: 0.0.0.0/0 # Create a rule for VRRP with numbered protocol 112 - openstack.cloud.security_group_rule: security_group: loadbalancer_sg protocol: 112 remote_group: loadbalancer-node_sg # Create a security group rule for a given project - openstack.cloud.security_group_rule: cloud: mordred security_group: foo protocol: icmp remote_ip_prefix: 0.0.0.0/0 project: myproj # Remove the default created egress rule for IPv4 - openstack.cloud.security_group_rule: cloud: mordred security_group: foo protocol: any remote_ip_prefix: 0.0.0.0/0 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| direction string \| state == present \| The direction in which the security group rule is applied. Sample: egress \| \| ethertype string \| state == present \| One of IPv4 or IPv6. Sample: IPv4 \| \| id string \| state == present \| Unique rule UUID. \| \| port\_range\_max integer \| state == present \| The maximum port number in the range that is matched by the security group rule. Sample: 8000 \| \| port\_range\_min integer \| state == present \| The minimum port number in the range that is matched by the security group rule. Sample: 8000 \| \| protocol string \| state == present \| The protocol that is matched by the security group rule. Sample: tcp \| \| remote\_ip\_prefix string \| state == present \| The remote IP prefix to be associated with this security group rule. Sample: 0.0.0.0/0 \| \| security\_group\_id string \| state == present \| The security group ID to associate with this security group rule. \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.volume_snapshot_info – Get volume snapshots openstack.cloud.volume\_snapshot\_info – Get volume snapshots ============================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.volume_snapshot_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get Volume Snapshot info from the Openstack cloud. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| details boolean \| Choices:* no * yes ← \| More detailed output \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name of the Snapshot. \| \| region\_name string \| \| Name of the region. \| \| status string \| Choices:* creating * available * error * deleting * error\_deleting * rollbacking * backing-up \| Specifies the snapshot status. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| volume string \| \| Name of the volume. \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Get snapshots. - openstack.cloud.volume_snapshot_info: register: snapshots - openstack.cloud.volume_snapshotbackup_info: name: my_fake_snapshot register: snapshot ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| volume\_snapshots list / elements=dictionary \| always. \| List of dictionaries describing volume snapshots. \| \| \| created\_at string \| success \| Snapshot creation time. \| \| \| description string \| success \| Snapshot desciption. \| \| \| id string \| success \| Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| \| metadata dictionary \| success \| Snapshot metadata. \| \| \| name string \| success \| Snapshot Name. \| \| \| status string \| success \| Snapshot status. \| \| \| updated\_at string \| success \| Snapshot update time. \| \| \| volume\_id string \| success \| Volume ID. \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.subnets_info – Retrieve information about one or more OpenStack subnets. openstack.cloud.subnets\_info – Retrieve information about one or more OpenStack subnets. ========================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.subnets_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve information about one or more subnets from OpenStack. * This module was called `openstack.cloud.subnets_facts` before Ansible 2.9, returning `ansible_facts`. Note that the [openstack.cloud.subnets\_info](#ansible-collections-openstack-cloud-subnets-info-module) module no longer returns `ansible_facts`! Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| filters dictionary \| \| A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name or ID of the subnet. Alias 'subnet' added in version 2.8. aliases: subnet \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Gather information about previously created subnets openstack.cloud.subnets_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject register: result - name: Show openstack subnets debug: msg: "{{ result.openstack_subnets }}" - name: Gather information about a previously created subnet by name openstack.cloud.subnets_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject name: subnet1 register: result - name: Show openstack subnets debug: msg: "{{ result.openstack_subnets }}" - name: Gather information about a previously created subnet with filter # Note: name and filters parameters are not mutually exclusive openstack.cloud.subnets_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject filters: tenant_id: 55e2ce24b2a245b09f181bf025724cbe register: result - name: Show openstack subnets debug: msg: "{{ result.openstack_subnets }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_subnets complex \| always, but can be null \| has all the openstack information about the subnets \| \| \| allocation\_pools list / elements=dictionary \| success \| Allocation pools associated with this subnet. \| \| \| cidr string \| success \| Subnet's CIDR. \| \| \| dns\_nameservers list / elements=string \| success \| DNS name servers for this subnet. \| \| \| enable\_dhcp boolean \| success \| DHCP enable flag for this subnet. \| \| \| gateway\_ip string \| success \| Subnet's gateway ip. \| \| \| id string \| success \| Unique UUID. \| \| \| ip\_version integer \| success \| IP version for this subnet. \| \| \| name string \| success \| Name given to the subnet. \| \| \| network\_id string \| success \| Network ID this subnet belongs in. \| \| \| tenant\_id string \| success \| Tenant id associated with this subnet. \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.volume – Create/Delete Cinder Volumes openstack.cloud.volume – Create/Delete Cinder Volumes ===================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.volume`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or Remove cinder block storage volumes Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| bootable boolean \| Choices:* no ← * yes \| Bootable flag for volume. \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| display\_description string \| \| String describing the volume aliases: description \| \| display\_name string / required \| \| Name of volume aliases: name \| \| image string \| \| Image name or id for boot from volume \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| metadata dictionary \| \| Metadata for the volume \| \| region\_name string \| \| Name of the region. \| \| scheduler\_hints dictionary \| \| Scheduler hints passed to volume API in form of dict \| \| size integer \| \| Size of volume in GB. This parameter is required when the state parameter is 'present'. \| \| snapshot\_id string \| \| Volume snapshot id to create from \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| volume string \| \| Volume name or id to create from \| \| volume\_type string \| \| Volume type for volume \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Creates a new volume - name: create a volume hosts: localhost tasks: - name: create 40g test volume openstack.cloud.volume: state: present cloud: mordred availability_zone: az2 size: 40 display_name: test_volume scheduler_hints: same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0 ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.lb_pool – Add/Delete a pool in the load balancing service from OpenStack Cloud openstack.cloud.lb\_pool – Add/Delete a pool in the load balancing service from OpenStack Cloud =============================================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.lb_pool`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove a pool from the OpenStack load-balancer service. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| lb\_algorithm string \| Choices:* LEAST\_CONNECTIONS * ROUND\_ROBIN ← * SOURCE\_IP \| The load balancing algorithm for the pool. \| \| listener string \| \| The name or id of the listener that this pool belongs to. Either loadbalancer or listener must be specified for pool creation. \| \| loadbalancer string \| \| The name or id of the load balancer that this pool belongs to. Either loadbalancer or listener must be specified for pool creation. \| \| name string / required \| \| Name that has to be given to the pool \| \| protocol string \| Choices:* HTTP ← * HTTPS * PROXY * TCP * UDP \| The protocol for the pool. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| The amount of time the module should wait for the pool to get into ACTIVE state. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the pool to be ACTIVE. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a pool, wait for the pool to be active. - openstack.cloud.lb_pool: cloud: mycloud endpoint_type: admin state: present name: test-pool loadbalancer: test-loadbalancer protocol: HTTP lb_algorithm: ROUND_ROBIN # Delete a pool - openstack.cloud.lb_pool: cloud: mycloud endpoint_type: admin state: absent name: test-pool ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| On success when state is 'present' \| The pool UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| listener complex \| On success when state is 'present' \| Dictionary describing the pool. \| \| \| description string \| success \| The pool description. Sample: description \| \| \| id string \| success \| Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| \| is\_admin\_state\_up boolean \| success \| The administrative state of the pool. Sample: True \| \| \| lb\_algorithm string \| success \| The load balancing algorithm for the pool. Sample: ROUND\_ROBIN \| \| \| listener\_id string \| success \| The listener ID the pool belongs to. Sample: 956aa716-9c2f-11e8-83b3-44a8422643a4 \| \| \| listeners list / elements=string \| success \| A list of listener IDs. Sample: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}] \| \| \| loadbalancer\_id string \| success \| The load balancer ID the pool belongs to. This field is set when the pool doesn't belong to any listener in the load balancer. Sample: 7c4be3f8-9c2f-11e8-83b3-44a8422643a4 \| \| \| loadbalancers list / elements=string \| success \| A list of load balancer IDs. Sample: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}] \| \| \| members list / elements=string \| success \| A list of member IDs. Sample: [{'id': 'b32eef7e-d2a6-4ea4-a301-60a873f89b3b'}] \| \| \| name string \| success \| Name given to the pool. Sample: test \| \| \| operating\_status string \| success \| The operating status of the pool. Sample: ONLINE \| \| \| protocol string \| success \| The protocol for the pool. Sample: HTTP \| \| \| provisioning\_status string \| success \| The provisioning status of the pool. Sample: ACTIVE \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.server – Create/Delete Compute Instances from OpenStack openstack.cloud.server – Create/Delete Compute Instances from OpenStack ======================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.server`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or Remove compute instances from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| auto\_ip boolean \| Choices:* no * yes ← \| Ensure instance has public ip however the cloud wants to do that aliases: auto\_floating\_ip, public\_ip \| \| availability\_zone string \| \| Availability zone in which to create the server. \| \| boot\_from\_volume boolean \| Choices:* no ← * yes \| Should the instance boot from a persistent volume created based on the image given. Mutually exclusive with boot\_volume. \| \| boot\_volume string \| \| Volume name or id to use as the volume to boot from. Implies boot\_from\_volume. Mutually exclusive with image and boot\_from\_volume. aliases: root\_volume \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| config\_drive boolean \| Choices:* no ← * yes \| Whether to boot the server with config drive enabled \| \| delete\_fip boolean \| Choices:* no ← * yes \| When state is absent and this option is true, any floating IP associated with the instance will be deleted along with the instance. \| \| description string \| \| Description of the server. \| \| flavor string \| \| The name or id of the flavor in which the new instance has to be created. Exactly one of flavor and flavor\_ram must be defined when state=present. \| \| flavor\_include string \| \| Text to use to filter flavor names, for the case, such as Rackspace, where there are multiple flavors that have the same ram count. flavor\_include is a positive match filter - it must exist in the flavor name. \| \| flavor\_ram integer \| \| The minimum amount of ram in MB that the flavor in which the new instance has to be created must have. Exactly one of flavor and flavor\_ram must be defined when state=present. \| \| floating\_ip\_pools list / elements=string \| \| Name of floating IP pool from which to choose a floating IP \| \| floating\_ips list / elements=string \| \| list of valid floating IPs that pre-exist to assign to this node \| \| image string \| \| The name or id of the base image to boot. Required when boot\_from\_volume=true \| \| image\_exclude string \| Default:"(deprecated)" \| Text to use to filter image names, for the case, such as HP, where there are multiple image names matching the common identifying portions. image\_exclude is a negative match filter - it is text that may not exist in the image name. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| key\_name string \| \| The key pair name to be used when creating a instance \| \| meta raw \| \| A list of key value pairs that should be provided as a metadata to the new instance or a string containing a list of key-value pairs. Eg: meta: "key1=value1,key2=value2" \| \| name string / required \| \| Name that has to be given to the instance. It is also possible to specify the ID of the instance instead of its name if state is absent. \| \| network string \| \| Name or ID of a network to attach this instance to. A simpler version of the nics parameter, only one of network or nics should be supplied. \| \| nics list / elements=raw \| \| A list of networks to which the instance's interface should be attached. Networks may be referenced by net-id/net-name/port-id or port-name. Also this accepts a string containing a list of (net/port)-(id/name) Eg: nics: "net-id=uuid-1,port-name=myport" Only one of network or nics should be supplied. \| \| \| tag string \| \| A "tag" for the specific port to be passed via metadata. Eg: tag: test\_tag \| \| region\_name string \| \| Name of the region. \| \| reuse\_ips boolean \| Choices:* no * yes ← \| When auto\_ip is true and this option is true, the auto\_ip code will attempt to re-use unassigned floating ips in the project before creating a new one. It is important to note that it is impossible to safely do this concurrently, so if your use case involves concurrent server creation, it is highly recommended to set this to false and to delete the floating ip associated with a server when the server is deleted using delete\_fip. \| \| scheduler\_hints dictionary \| \| Arbitrary key/value pairs to the scheduler for custom use \| \| security\_groups list / elements=string \| Default:["default"] \| Names of the security groups to which the instance should be added. This may be a YAML list or a comma separated string. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| terminate\_volume boolean \| Choices:* no ← * yes \| If `yes`, delete volume when deleting instance (if booted from volume) \| \| timeout integer \| Default:180 \| The amount of time the module should wait for the instance to get into active state. \| \| userdata string \| \| Opaque blob of data which is made available to the instance aliases: user\_data \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| volume\_size integer \| \| The size of the volume to create in GB if booting from volume based on an image. \| \| volumes list / elements=string \| Default:[] \| A list of preexisting volumes names or ids to attach to the instance \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the instance to be created. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Create a new instance and attaches to a network and passes metadata to the instance openstack.cloud.server: state: present auth: auth_url: https://identity.example.com username: admin password: admin project_name: admin name: vm1 image: 4f905f38-e52a-43d2-b6ec-754a13ffb529 key_name: ansible_key timeout: 200 flavor: 4 nics: - net-id: 34605f38-e52a-25d2-b6ec-754a13ffb723 - net-name: another_network meta: hostname: test1 group: uge_master # Create a new instance in HP Cloud AE1 region availability zone az2 and # automatically assigns a floating IP - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: state: present auth: auth_url: https://identity.example.com username: username password: Equality7-2521 project_name: username-project1 name: vm1 region_name: region-b.geo-1 availability_zone: az2 image: 9302692b-b787-4b52-a3a6-daebb79cb498 key_name: test timeout: 200 flavor: 101 security_groups: default auto_ip: yes # Create a new instance in named cloud mordred availability zone az2 # and assigns a pre-known floating IP - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: state: present cloud: mordred name: vm1 availability_zone: az2 image: 9302692b-b787-4b52-a3a6-daebb79cb498 key_name: test timeout: 200 flavor: 101 floating_ips: - 12.34.56.79 # Create a new instance with 4G of RAM on Ubuntu Trusty, ignoring # deprecated images - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: name: vm1 state: present cloud: mordred region_name: region-b.geo-1 image: Ubuntu Server 14.04 image_exclude: deprecated flavor_ram: 4096 # Create a new instance with 4G of RAM on Ubuntu Trusty on a Performance node - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: name: vm1 cloud: rax-dfw state: present image: Ubuntu 14.04 LTS (Trusty Tahr) (PVHVM) flavor_ram: 4096 flavor_include: Performance # Creates a new instance and attaches to multiple network - name: launch a compute instance hosts: localhost tasks: - name: launch an instance with a string openstack.cloud.server: auth: auth_url: https://identity.example.com username: admin password: admin project_name: admin name: vm1 image: 4f905f38-e52a-43d2-b6ec-754a13ffb529 key_name: ansible_key timeout: 200 flavor: 4 nics: "net-id=4cb08b20-62fe-11e5-9d70-feff819cdc9f,net-id=542f0430-62fe-11e5-9d70-feff819cdc9f..." - name: Creates a new instance and attaches to a network and passes metadata to the instance openstack.cloud.server: state: present auth: auth_url: https://identity.example.com username: admin password: admin project_name: admin name: vm1 image: 4f905f38-e52a-43d2-b6ec-754a13ffb529 key_name: ansible_key timeout: 200 flavor: 4 nics: - net-id: 34605f38-e52a-25d2-b6ec-754a13ffb723 - net-name: another_network meta: "hostname=test1,group=uge_master" - name: Creates a new instance and attaches to a specific network openstack.cloud.server: state: present auth: auth_url: https://identity.example.com username: admin password: admin project_name: admin name: vm1 image: 4f905f38-e52a-43d2-b6ec-754a13ffb529 key_name: ansible_key timeout: 200 flavor: 4 network: another_network # Create a new instance with 4G of RAM on a 75G Ubuntu Trusty volume - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: name: vm1 state: present cloud: mordred region_name: ams01 image: Ubuntu Server 14.04 flavor_ram: 4096 boot_from_volume: True volume_size: 75 # Creates a new instance with 2 volumes attached - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: name: vm1 state: present cloud: mordred region_name: ams01 image: Ubuntu Server 14.04 flavor_ram: 4096 volumes: - photos - music # Creates a new instance with provisioning userdata using Cloud-Init - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: name: vm1 state: present image: "Ubuntu Server 14.04" flavor: "P-1" network: "Production" userdata: \| #cloud-config chpasswd: list: \| ubuntu:{{ default_password }} expire: False packages: - ansible package_upgrade: true # Creates a new instance with provisioning userdata using Bash Scripts - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: name: vm1 state: present image: "Ubuntu Server 14.04" flavor: "P-1" network: "Production" userdata: \| {%- raw -%}#!/bin/bash echo " up ip route add 10.0.0.0/8 via {% endraw -%}{{ intra_router }}{%- raw -%}" >> /etc/network/interfaces.d/eth0.conf echo " down ip route del 10.0.0.0/8" >> /etc/network/interfaces.d/eth0.conf ifdown eth0 && ifup eth0 {% endraw %} # Create a new instance with server group for (anti-)affinity # server group ID is returned from openstack.cloud.server_group module. - name: launch a compute instance hosts: localhost tasks: - name: launch an instance openstack.cloud.server: state: present name: vm1 image: 4f905f38-e52a-43d2-b6ec-754a13ffb529 flavor: 4 scheduler_hints: group: f5c8c61a-9230-400a-8ed2-3b023c190a7f # Create an instance with "tags" for the nic - name: Create instance with nics "tags" openstack.cloud.server: state: present auth: auth_url: https://identity.example.com username: admin password: admin project_name: admin name: vm1 image: 4f905f38-e52a-43d2-b6ec-754a13ffb529 key_name: ansible_key flavor: 4 nics: - port-name: net1_port1 tag: test_tag - net-name: another_network # Deletes an instance via its ID - name: remove an instance hosts: localhost tasks: - name: remove an instance openstack.cloud.server: name: abcdef01-2345-6789-0abc-def0123456789 state: absent ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.floating_ip – Add/Remove floating IP from an instance openstack.cloud.floating\_ip – Add/Remove floating IP from an instance ====================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.floating_ip`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add or Remove a floating IP to an instance. * Returns the floating IP when attaching only if wait=true. * When detaching a floating IP there might be a delay until an instance does not list the floating IP any more. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| fixed\_address string \| \| To which fixed IP of server the floating IP address should be attached to. \| \| floating\_ip\_address string \| \| A floating IP address to attach or to detach. When state is present can be used to specify a IP address to attach. floating\_ip\_address requires network to be set. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| nat\_destination string \| \| The name or id of a neutron private network that the fixed IP to attach floating IP is on aliases: fixed\_network, internal\_network \| \| network string \| \| The name or ID of a neutron external network or a nova pool name. \| \| purge boolean \| Choices:* no ← * yes \| When state is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only. \| \| region\_name string \| \| Name of the region. \| \| reuse boolean \| Choices:* no ← * yes \| When state is present, and floating\_ip\_address is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project. \| \| server string / required \| \| The name or ID of the instance to which the IP address should be assigned. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:60 \| Time to wait for an IP address to appear as attached. See wait. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no ← * yes \| When attaching a floating IP address, specify whether to wait for it to appear as attached. Must be set to `yes` for the module to return the value of the floating IP when attaching. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Assign a floating IP to the first interface of `cattle001` from an existing # external network or nova pool. A new floating IP from the first available # external network is allocated to the project. - openstack.cloud.floating_ip: cloud: dguerri server: cattle001 # Assign a new floating IP to the instance fixed ip `192.0.2.3` of # `cattle001`. If a free floating IP is already allocated to the project, it is # reused; if not, a new one is created. - openstack.cloud.floating_ip: cloud: dguerri state: present reuse: yes server: cattle001 network: ext_net fixed_address: 192.0.2.3 wait: true timeout: 180 # Assign a new floating IP from the network `ext_net` to the instance fixed # ip in network `private_net` of `cattle001`. - openstack.cloud.floating_ip: cloud: dguerri state: present server: cattle001 network: ext_net nat_destination: private_net wait: true timeout: 180 # Detach a floating IP address from a server - openstack.cloud.floating_ip: cloud: dguerri state: absent floating_ip_address: 203.0.113.2 server: cattle001 ``` ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.role_assignment – Associate OpenStack Identity users and roles openstack.cloud.role\_assignment – Associate OpenStack Identity users and roles =============================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.role_assignment`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Grant and revoke roles in either project or domain context for OpenStack Identity Users. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| domain string \| \| Name or ID of the domain to scope the role association to. Valid only with keystone version 3, and required if project is not specified. \| \| group string \| \| Name or ID for the group. Valid only with keystone version 3. If group is not specified, then user is required. Both may not be specified. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| project string \| \| Name or ID of the project to scope the role association to. If you are using keystone version 2, then this value is required. \| \| region\_name string \| \| Name of the region. \| \| role string / required \| \| Name or ID for the role. \| \| state string \| Choices:* present ← * absent \| Should the roles be present or absent on the user. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| user string \| \| Name or ID for the user. If user is not specified, then group is required. Both may not be specified. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Grant an admin role on the user admin in the project project1 - openstack.cloud.role_assignment: cloud: mycloud user: admin role: admin project: project1 # Revoke the admin role from the user barney in the newyork domain - openstack.cloud.role_assignment: cloud: mycloud state: absent user: barney role: admin domain: newyork ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.identity_role – Manage OpenStack Identity Roles openstack.cloud.identity\_role – Manage OpenStack Identity Roles ================================================================ Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.identity_role`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OpenStack Identity Roles. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Role Name \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a role named "demo" - openstack.cloud.identity_role: cloud: mycloud state: present name: demo # Delete the role named "demo" - openstack.cloud.identity_role: cloud: mycloud state: absent name: demo ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| role complex \| On success when state is 'present'. \| Dictionary describing the role. \| \| \| id string \| success \| Unique role ID. Sample: 677bfab34c844a01b88a217aa12ec4c2 \| \| \| name string \| success \| Role name. Sample: demo \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.keystone_federation_protocol – manage a federation Protocol openstack.cloud.keystone\_federation\_protocol – manage a federation Protocol ============================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.keystone_federation_protocol`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manage a federation Protocol. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk >= 0.12.0 * openstacksdk >= 0.44 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| idp\_id string / required \| \| The name of the Identity Provider this Protocol is associated with. aliases: idp\_name \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| mapping\_id string \| \| The name of the Mapping to use for this Protocol.' Required when creating a new Protocol. aliases: mapping\_name \| \| name string / required \| \| The name of the Protocol. aliases: id \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Whether the protocol should be `present` or `absent`. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Create a protocol openstack.cloud.keystone_federation_protocol: cloud: example_cloud name: example_protocol idp_id: example_idp mapping_id: example_mapping - name: Delete a protocol openstack.cloud.keystone_federation_protocol: cloud: example_cloud name: example_protocol idp_id: example_idp state: absent ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.server_group – Manage OpenStack server groups openstack.cloud.server\_group – Manage OpenStack server groups ============================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.server_group`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or remove server groups from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Server group name. \| \| policies list / elements=string \| \| A list of one or more policy names to associate with the server group. The list must contain at least one policy name. The current valid policy names are anti-affinity, affinity, soft-anti-affinity and soft-affinity. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource. When state is 'present', then policies is required. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a server group with 'affinity' policy. - openstack.cloud.server_group: state: present auth: auth_url: https://identity.example.com username: admin password: admin project_name: admin name: my_server_group policies: - affinity # Delete 'my_server_group' server group. - openstack.cloud.server_group: state: absent auth: auth_url: https://identity.example.com username: admin password: admin project_name: admin name: my_server_group ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| success \| Unique UUID. \| \| members list / elements=string \| success \| A list of members in the server group. \| \| metadata dictionary \| success \| Metadata key and value pairs. \| \| name string \| success \| The name of the server group. \| \| policies list / elements=string \| success \| A list of one or more policy names of the server group. \| \| project\_id string \| success \| The project ID who owns the server group. \| \| user\_id string \| success \| The user ID who owns the server group. \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.stack – Add/Remove Heat Stack openstack.cloud.stack – Add/Remove Heat Stack ============================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.stack`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove a Stack to an OpenStack Heat Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| environment list / elements=string \| \| List of environment files that should be used for the stack creation \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Name of the stack that should be created, name could be char and digit, no space \| \| parameters dictionary \| \| Dictionary of parameters for the stack creation \| \| region\_name string \| \| Name of the region. \| \| rollback boolean \| Choices:* no ← * yes \| Rollback stack creation \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource \| \| tag string \| \| Tag for the stack that should be created, name could be char and digit, no space \| \| template string \| \| Path of the template file to use for the stack creation \| \| timeout integer \| Default:3600 \| Maximum number of seconds to wait for the stack creation \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` --- - name: create stack ignore_errors: True register: stack_create openstack.cloud.stack: name: "{{ stack_name }}" tag: "{{ tag_name }}" state: present template: "/path/to/my_stack.yaml" environment: - /path/to/resource-registry.yaml - /path/to/environment.yaml parameters: bmc_flavor: m1.medium bmc_image: CentOS key_name: default private_net: "{{ private_net_param }}" node_count: 2 name: undercloud image: CentOS my_flavor: m1.large external_net: "{{ external_net_param }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| always \| Stack ID. Sample: 97a3f543-8136-4570-920e-fd7605c989d6 \| \| stack complex \| always \| stack info \| \| \| action string \| success \| Action, could be Create or Update. Sample: CREATE \| \| \| creation\_time string \| success \| Time when the action has been made. Sample: 2016-07-05T17:38:12Z \| \| \| description string \| success \| Description of the Stack provided in the heat template. Sample: HOT template to create a new instance and networks \| \| \| id string \| success \| Stack ID. Sample: 97a3f543-8136-4570-920e-fd7605c989d6 \| \| \| identifier string \| success \| Identifier of the current Stack action. Sample: test-stack/97a3f543-8136-4570-920e-fd7605c989d6 \| \| \| links list / elements=dictionary \| success \| Links to the current Stack. Sample: [{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6'] \| \| \| name string \| success \| Name of the Stack Sample: test-stack \| \| \| outputs list / elements=dictionary \| success \| Output returned by the Stack. Sample: {'description': 'IP address of server1 in private network', 'output\_key': 'server1\_private\_ip', 'output\_value': '10.1.10.103'} \| \| \| parameters dictionary \| success \| Parameters of the current Stack Sample: {'OS::project\_id': '7f6a3a3e01164a4eb4eecb2ab7742101', 'OS::stack\_id': '97a3f543-8136-4570-920e-fd7605c989d6', 'OS::stack\_name': 'test-stack', 'stack\_status': 'CREATE\_COMPLETE', 'stack\_status\_reason': 'Stack CREATE completed successfully', 'status': 'COMPLETE', 'template\_description': 'HOT template to create a new instance and networks', 'timeout\_mins': 60, 'updated\_time': null} \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.dns_zone_info – Getting information about dns zones openstack.cloud.dns\_zone\_info – Getting information about dns zones ===================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.dns_zone_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Getting information about dns zones. Output can be filtered. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Zone description. \| \| email string \| \| Email of the zone owner (only applies if zone\_type is primary). \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Zone name. \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| ttl integer \| \| TTL (Time To Live) value in seconds. \| \| type string \| Choices:* primary * secondary \| Zone type. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a zone named "example.net" - openstack.cloud.dns_zones: ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| zone complex \| On success when state is 'present'. \| Dictionary describing the zone. \| \| \| action string \| success \| Current action in progress on the resource. Sample: CREATE \| \| \| attributes dictionary \| success \| Key:Value pairs of information about this zone, and the pool the user would like to place the zone in. This information can be used by the scheduler to place zones on the correct pool. Sample: {'ha': 'true', 'tier': 'gold'} \| \| \| created\_at string \| success \| Date / Time when resource was created. Sample: 2014-07-07T18:25:31.275934 \| \| \| description string \| success \| Description for this zone. Sample: This is an example zone. \| \| \| email string \| success \| E-mail for the zone. Used in SOA records for the zone. Sample: [email protected] \| \| \| id integer \| success \| ID for the resource. Sample: a86dba58-0043-4cc6-a1bb-69d5e86f3ca3 \| \| \| links dictionary \| success \| Links to the resource, and other related resources. When a response has been broken into pages, we will include a next link that should be followed to retrieve all results. Sample: {'self': 'https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3'} \| \| \| masters list / elements=string \| success \| Mandatory for secondary zones. The servers to slave from to get DNS information. Sample: [] \| \| \| name string \| success \| DNS Name for the zone. Sample: test.test. \| \| \| pool\_id string \| success \| ID for the pool hosting this zone. Sample: a86dba58-0043-4cc6-a1bb-69d5e86f3ca3 \| \| \| project\_id string \| success \| ID for the project that owns the resource. Sample: 4335d1f0-f793-11e2-b778-0800200c9a66 \| \| \| serial integer \| success \| Current serial number for the zone. Sample: 1404757531 \| \| \| status string \| success \| Status of the resource. Sample: ACTIVE \| \| \| ttl integer \| success \| TTL (Time to Live) for the zone. Sample: 7200 \| \| \| type string \| success \| Type of zone. PRIMARY is controlled by Designate, SECONDARY zones are slaved from another DNS Server. Defaults to PRIMARY Sample: PRIMARY \| \| \| updated\_at string \| success \| Date / Time when resource last updated. Sample: 2014-07-07T18:25:31.275934 \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.routers_info – Retrieve information about one or more OpenStack routers. openstack.cloud.routers\_info – Retrieve information about one or more OpenStack routers. ========================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.routers_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve information about one or more routers from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| filters dictionary \| \| A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. \| \| \| admin\_state\_up boolean \| Choices:* no * yes \| Filter the list result by the administrative state of the resource, which is up (true) or down (false). \| \| \| description string \| \| Filter the list result by the human-readable description of the resource. \| \| \| name string \| \| Filter the list result by the human-readable name of the resource. \| \| \| project\_id string \| \| Filter the list result by the ID of the project that owns the resource. aliases: tenant\_id \| \| \| revision\_number integer \| \| Filter the list result by the revision number of the resource. \| \| \| tags list / elements=string \| \| A list of tags to filter the list result by. Resources that match all tags in this list will be returned. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name or ID of the router \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Gather information about routers openstack.cloud.routers_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject register: result - name: Show openstack routers debug: msg: "{{ result.openstack_routers }}" - name: Gather information about a router by name openstack.cloud.routers_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject name: router1 register: result - name: Show openstack routers debug: msg: "{{ result.openstack_routers }}" - name: Gather information about a router with filter openstack.cloud.routers_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject filters: tenant_id: bc3ea709c96849d6b81f54640400a19f register: result - name: Show openstack routers debug: msg: "{{ result.openstack_routers }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_routers complex \| always, but can be null \| has all the openstack information about the routers \| \| \| distributed boolean \| success \| Indicates a distributed router. \| \| \| external\_gateway\_info dictionary \| success \| The external gateway information of the router. \| \| \| ha boolean \| success \| Indicates a highly-available router. \| \| \| id string \| success \| Unique UUID. \| \| \| interfaces\_info list / elements=string \| success \| List of connected interfaces. \| \| \| name string \| success \| Name given to the router. \| \| \| project\_id string \| success \| Project id associated with this router. \| \| \| routes list / elements=string \| success \| The extra routes configuration for L3 router. \| \| \| status string \| success \| Router status. \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.identity_domain – Manage OpenStack Identity Domains openstack.cloud.identity\_domain – Manage OpenStack Identity Domains ==================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.identity_domain`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update, or delete OpenStack Identity domains. If a domain with the supplied name already exists, it will be updated with the new description and enabled attributes. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Description of the domain \| \| enabled boolean \| Choices:* no * yes ← \| Is the domain enabled \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Name that has to be given to the instance \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a domain - openstack.cloud.identity_domain: cloud: mycloud state: present name: demo description: Demo Domain # Delete a domain - openstack.cloud.identity_domain: cloud: mycloud state: absent name: demo ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| domain complex \| On success when state is 'present' \| Dictionary describing the domain. \| \| \| description string \| success \| Domain description. Sample: Demo Domain \| \| \| enabled boolean \| success \| Domain description. Sample: True \| \| \| id string \| success \| Domain ID. Sample: 474acfe5-be34-494c-b339-50f06aa143e4 \| \| \| name string \| success \| Domain name. Sample: demo \| \| id string \| On success when state is 'present' \| The domain ID. Sample: 474acfe5-be34-494c-b339-50f06aa143e4 \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.identity_role_info – Retrive information about roles openstack.cloud.identity\_role\_info – Retrive information about roles ====================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.identity_role_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get information about identity roles in Openstack Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| domain\_id string \| \| List roles in specified domain only \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| List role speficied by name \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Retrieve info about all roles - openstack.cloud.identity_role_info: cloud: mycloud # Retrieve info about all roles in specific domain - openstack.cloud.identity_role_info: cloud: mycloud domain_id: some_domain_id # Retrieve info about role 'admin' - openstack.cloud.identity_role_info: cloud: mycloud name: admin ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_roles list / elements=dictionary \| always \| List of identity roles Sample: [{'domain\_id': 'None', 'id': '19bf514fdda84f808ccee8463bd85c1a', 'location': {'cloud': 'mycloud', 'project': {'domain\_id': 'None', 'domain\_name': 'None', 'id': 'None', 'name': 'None'}, 'region\_name': 'None', 'zone': 'None'}, 'name': 'member', 'properties': None}] \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.dns_zone – Manage OpenStack DNS zones openstack.cloud.dns\_zone – Manage OpenStack DNS zones ====================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.dns_zone`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OpenStack DNS zones. Zones can be created, deleted or updated. Only the email, description, ttl and masters values can be updated. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Zone description \| \| email string \| \| Email of the zone owner (only applies if zone\_type is primary) \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| masters list / elements=string \| \| Master nameservers (only applies if zone\_type is secondary) \| \| name string / required \| \| Zone name \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| ttl integer \| \| TTL (Time To Live) value in seconds \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| \| zone\_type string \| Choices:* primary * secondary \| Zone type \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a zone named "example.net" - openstack.cloud.dns_zone: cloud: mycloud state: present name: example.net. zone_type: primary email: [email protected] description: Test zone ttl: 3600 # Update the TTL on existing "example.net." zone - openstack.cloud.dns_zone: cloud: mycloud state: present name: example.net. ttl: 7200 # Delete zone named "example.net." - openstack.cloud.dns_zone: cloud: mycloud state: absent name: example.net. ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| zone complex \| On success when state is 'present'. \| Dictionary describing the zone. \| \| \| description string \| success \| Zone description Sample: Test description \| \| \| email string \| success \| Zone owner email Sample: [email protected] \| \| \| id string \| success \| Unique zone ID Sample: c1c530a3-3619-46f3-b0f6-236927b2618c \| \| \| masters list / elements=string \| success \| Zone master nameservers \| \| \| name string \| success \| Zone name Sample: example.net. \| \| \| ttl integer \| success \| Zone TTL value Sample: 3600 \| \| \| type string \| success \| Zone type Sample: PRIMARY \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.baremetal_inspect – Explicitly triggers baremetal node introspection in ironic. openstack.cloud.baremetal\_inspect – Explicitly triggers baremetal node introspection in ironic. ================================================================================================ Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.baremetal_inspect`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Returned Facts](#returned-facts) Synopsis -------- * Requests Ironic to set a node into inspect state in order to collect metadata regarding the node. This command may be out of band or in-band depending on the ironic driver configuration. This is only possible on nodes in ‘manageable’ and ‘available’ state. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| ironic\_url string \| \| If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with "auth" and "auth\_type" settings set to None. \| \| mac string \| \| unique mac address that is used to attempt to identify the host. \| \| name string \| \| unique name identifier to identify the host in Ironic. \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:1200 \| A timeout in seconds to tell the role to wait for the node to complete introspection if wait is set to True. \| \| uuid string \| \| globally unique identifier (UUID) to identify the host. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Invoke node inspection - openstack.cloud.baremetal_inspect: name: "testnode1" ``` Returned Facts -------------- Facts returned by this module are added/updated in the `hostvars` host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them. \| Fact \| Returned \| Description \| \| --- \| --- \| --- \| \| cpu\_arch string / elements=string \| success \| Detected CPU architecture type Sample: x86\_64 \| \| cpus string / elements=string \| success \| Count of cpu cores defined in the updated node properties. Sample: 1 \| \| local\_gb string / elements=string \| success \| Total size of local disk storage as updated in node properties. Sample: 10 \| \| memory\_mb string / elements=string \| success \| Amount of node memory as updated in the node properties Sample: 1024 \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.catalog_service – Manage OpenStack Identity services openstack.cloud.catalog\_service – Manage OpenStack Identity services ===================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.catalog_service`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, update, or delete OpenStack Identity service. If a service with the supplied name already exists, it will be updated with the new description and enabled attributes. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Description of the service \| \| enabled boolean \| Choices:* no * yes ← \| Is the service enabled \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Name of the service \| \| region\_name string \| \| Name of the region. \| \| service\_type string / required \| \| The type of service \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a service for glance - openstack.cloud.catalog_service: cloud: mycloud state: present name: glance service_type: image description: OpenStack Image Service # Delete a service - openstack.cloud.catalog_service: cloud: mycloud state: absent name: glance service_type: image ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| On success when state is 'present' \| The service ID. Sample: 3292f020780b4d5baf27ff7e1d224c44 \| \| service complex \| On success when state is 'present' \| Dictionary describing the service. \| \| \| description string \| success \| Service description. Sample: OpenStack Image Service \| \| \| enabled boolean \| success \| Service status. Sample: True \| \| \| id string \| success \| Service ID. Sample: 3292f020780b4d5baf27ff7e1d224c44 \| \| \| name string \| success \| Service name. Sample: glance \| \| \| service\_type string \| success \| Service type. Sample: image \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.federation_idp_info – Get the information about the available federation identity providers openstack.cloud.federation\_idp\_info – Get the information about the available federation identity providers ============================================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.federation_idp_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Fetch a federation identity provider. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk >= 0.12.0 * openstacksdk >= 0.44 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| The name of the identity provider to fetch. If name is specified, the module will return failed if the identity provider doesn't exist. aliases: id \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Fetch a specific identity provider openstack.cloud.federation_idp_info: cloud: example_cloud name: example_provider - name: Fetch all providers openstack.cloud.federation_idp_info: cloud: example_cloud ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.compute_flavor_info – Retrieve information about one or more flavors openstack.cloud.compute\_flavor\_info – Retrieve information about one or more flavors ====================================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.compute_flavor_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve information about available OpenStack instance flavors. By default, information about ALL flavors are retrieved. Filters can be applied to get information for only matching flavors. For example, you can filter on the amount of RAM available to the flavor, or the number of virtual CPUs available to the flavor, or both. When specifying multiple filters, ALL filters must match on a flavor before that flavor is returned as a fact. * This module was called `openstack.cloud.compute_flavor_facts` before Ansible 2.9, returning `ansible_facts`. Note that the [openstack.cloud.compute\_flavor\_info](#ansible-collections-openstack-cloud-compute-flavor-info-module) module no longer returns `ansible_facts`! Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| ephemeral string \| \| A string used for filtering flavors based on the amount of ephemeral storage. Format is the same as the ram parameter \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| limit integer \| \| Limits the number of flavors returned. All matching flavors are returned by default. \| \| name string \| \| A flavor name. Cannot be used with ram or vcpus or ephemeral. \| \| ram string \| \| A string used for filtering flavors based on the amount of RAM (in MB) desired. This string accepts the following special values: 'MIN' (return flavors with the minimum amount of RAM), and 'MAX' (return flavors with the maximum amount of RAM). A specific amount of RAM may also be specified. Any flavors with this exact amount of RAM will be returned. A range of acceptable RAM may be given using a special syntax. Simply prefix the amount of RAM with one of these acceptable range values: '<', '>', '<=', '>='. These values represent less than, greater than, less than or equal to, and greater than or equal to, respectively. \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| vcpus string \| \| A string used for filtering flavors based on the number of virtual CPUs desired. Format is the same as the ram parameter. \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The result contains a list of unsorted flavors. * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Gather information about all available flavors - openstack.cloud.compute_flavor_info: cloud: mycloud register: result - debug: msg: "{{ result.openstack_flavors }}" # Gather information for the flavor named "xlarge-flavor" - openstack.cloud.compute_flavor_info: cloud: mycloud name: "xlarge-flavor" # Get all flavors that have exactly 512 MB of RAM. - openstack.cloud.compute_flavor_info: cloud: mycloud ram: "512" # Get all flavors that have 1024 MB or more of RAM. - openstack.cloud.compute_flavor_info: cloud: mycloud ram: ">=1024" # Get a single flavor that has the minimum amount of RAM. Using the 'limit' # option will guarantee only a single flavor is returned. - openstack.cloud.compute_flavor_info: cloud: mycloud ram: "MIN" limit: 1 # Get all flavors with 1024 MB of RAM or more, AND exactly 2 virtual CPUs. - openstack.cloud.compute_flavor_info: cloud: mycloud ram: ">=1024" vcpus: "2" # Get all flavors with 1024 MB of RAM or more, exactly 2 virtual CPUs, and # less than 30gb of ephemeral storage. - openstack.cloud.compute_flavor_info: cloud: mycloud ram: ">=1024" vcpus: "2" ephemeral: "<30" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_flavors complex \| On success. \| Dictionary describing the flavors. \| \| \| disk integer \| success \| Size of local disk, in GB. Sample: 10 \| \| \| ephemeral integer \| success \| Ephemeral space size, in GB. Sample: 10 \| \| \| id string \| success \| Flavor ID. Sample: 515256b8-7027-4d73-aa54-4e30a4a4a339 \| \| \| is\_public boolean \| success \| Make flavor accessible to the public. Sample: True \| \| \| name string \| success \| Flavor name. Sample: tiny \| \| \| ram integer \| success \| Amount of memory, in MB. Sample: 1024 \| \| \| swap integer \| success \| Swap space size, in MB. Sample: 100 \| \| \| vcpus integer \| success \| Number of virtual CPUs. Sample: 2 \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.identity_group – Manage OpenStack Identity Groups openstack.cloud.identity\_group – Manage OpenStack Identity Groups ================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.identity_group`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OpenStack Identity Groups. Groups can be created, deleted or updated. Only the description value can be updated. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Group description \| \| domain\_id string \| \| Domain id to create the group in if the cloud supports domains. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Group name \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a group named "demo" - openstack.cloud.identity_group: cloud: mycloud state: present name: demo description: "Demo Group" domain_id: demoid # Update the description on existing "demo" group - openstack.cloud.identity_group: cloud: mycloud state: present name: demo description: "Something else" domain_id: demoid # Delete group named "demo" - openstack.cloud.identity_group: cloud: mycloud state: absent name: demo ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| group complex \| On success when state is 'present'. \| Dictionary describing the group. \| \| \| description string \| success \| Group description Sample: Demo Group \| \| \| domain\_id string \| success \| Domain for the group Sample: default \| \| \| id string \| success \| Unique group ID Sample: ee6156ff04c645f481a6738311aea0b0 \| \| \| name string \| success \| Group name Sample: demo \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.project_access – Manage OpenStack compute flavors access openstack.cloud.project\_access – Manage OpenStack compute flavors access ========================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.project_access`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or remove flavor, volume\_type or other resources access from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| region\_name string \| \| Name of the region. \| \| resource\_name string / required \| \| The resource name (eg. tiny). \| \| resource\_type string / required \| \| The resource type (eg. nova\_flavor, cinder\_volume\_type). \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource. \| \| target\_project\_id string / required \| \| Project id. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: "Enable access to tiny flavor to your tenant." openstack.cloud.project_access: cloud: mycloud state: present target_project_id: f0f1f2f3f4f5f67f8f9e0e1 resource_name: tiny resource_type: nova_flavor - name: "Disable access to the given flavor to project" openstack.cloud.project_access: cloud: mycloud state: absent target_project_id: f0f1f2f3f4f5f67f8f9e0e1 resource_name: tiny resource_type: nova_flavor ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| flavor complex \| On success when state is 'present' \| Dictionary describing the flavor. \| \| \| id string \| success \| Flavor ID. Sample: 515256b8-7027-4d73-aa54-4e30a4a4a339 \| \| \| name string \| success \| Flavor name. Sample: tiny \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.quota – Manage OpenStack Quotas openstack.cloud.quota – Manage OpenStack Quotas =============================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.quota`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OpenStack Quotas. Quotas can be created, updated or deleted using this module. A quota will be updated if matches an existing project and is present. Requirements ------------ The below requirements are needed on the host that executes this module. * keystoneauth1 >= 3.4.0 * openstacksdk >= 0.12.0 * openstacksdk >= 0.13.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| backup\_gigabytes integer \| \| Maximum size of backups in GB's. \| \| backups integer \| \| Maximum number of backups allowed. \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| cores integer \| \| Maximum number of CPU's per project. \| \| fixed\_ips integer \| \| Number of fixed IP's to allow. \| \| floating\_ips integer \| \| Number of floating IP's to allow in Compute. aliases: compute\_floating\_ips \| \| floatingip integer \| \| Number of floating IP's to allow in Network. aliases: network\_floating\_ips \| \| gigabytes integer \| \| Maximum volume storage allowed for project. \| \| gigabytes\_types dictionary \| \| Per driver volume storage quotas. Keys should be prefixed with `gigabytes_` values should be ints. \| \| injected\_file\_size integer \| \| Maximum file size in bytes. \| \| injected\_files integer \| \| Number of injected files to allow. \| \| injected\_path\_size integer \| \| Maximum path size. \| \| instances integer \| \| Maximum number of instances allowed. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| key\_pairs integer \| \| Number of key pairs to allow. \| \| loadbalancer integer \| \| Number of load balancers to allow. \| \| name string / required \| \| Name of the OpenStack Project to manage. \| \| network integer \| \| Number of networks to allow. \| \| per\_volume\_gigabytes integer \| \| Maximum size in GB's of individual volumes. \| \| pool integer \| \| Number of load balancer pools to allow. \| \| port integer \| \| Number of Network ports to allow, this needs to be greater than the instances limit. \| \| project integer \| \| Unused, kept for compatability \| \| properties integer \| \| Number of properties to allow. \| \| ram integer \| \| Maximum amount of ram in MB to allow. \| \| rbac\_policy integer \| \| Number of policies to allow. \| \| region\_name string \| \| Name of the region. \| \| router integer \| \| Number of routers to allow. \| \| security\_group integer \| \| Number of security groups to allow. \| \| security\_group\_rule integer \| \| Number of rules per security group to allow. \| \| server\_group\_members integer \| \| Number of server group members to allow. \| \| server\_groups integer \| \| Number of server groups to allow. \| \| snapshots integer \| \| Number of snapshots to allow. \| \| snapshots\_types dictionary \| \| Per-driver volume snapshot quotas. Keys should be prefixed with `snapshots_` values should be ints. \| \| state string \| Choices:* absent * present ← \| A value of present sets the quota and a value of absent resets the quota to system defaults. \| \| subnet integer \| \| Number of subnets to allow. \| \| subnetpool integer \| \| Number of subnet pools to allow. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| volumes integer \| \| Number of volumes to allow. \| \| volumes\_types dictionary \| \| Per-driver volume count quotas. Keys should be prefixed with `gigabytes_` values should be ints. \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # List a Project Quota - openstack.cloud.quota: cloud: mycloud name: demoproject # Set a Project back to the defaults - openstack.cloud.quota: cloud: mycloud name: demoproject state: absent # Update a Project Quota for cores - openstack.cloud.quota: cloud: mycloud name: demoproject cores: 100 # Update a Project Quota - openstack.cloud.quota: name: demoproject cores: 1000 volumes: 20 volumes_type: - volume_lvm: 10 # Complete example based on list of projects - name: Update quotas openstack.cloud.quota: name: "{{ item.name }}" backup_gigabytes: "{{ item.backup_gigabytes }}" backups: "{{ item.backups }}" cores: "{{ item.cores }}" fixed_ips: "{{ item.fixed_ips }}" floating_ips: "{{ item.floating_ips }}" floatingip: "{{ item.floatingip }}" gigabytes: "{{ item.gigabytes }}" injected_file_size: "{{ item.injected_file_size }}" injected_files: "{{ item.injected_files }}" injected_path_size: "{{ item.injected_path_size }}" instances: "{{ item.instances }}" key_pairs: "{{ item.key_pairs }}" loadbalancer: "{{ item.loadbalancer }}" per_volume_gigabytes: "{{ item.per_volume_gigabytes }}" pool: "{{ item.pool }}" port: "{{ item.port }}" properties: "{{ item.properties }}" ram: "{{ item.ram }}" security_group_rule: "{{ item.security_group_rule }}" security_group: "{{ item.security_group }}" server_group_members: "{{ item.server_group_members }}" server_groups: "{{ item.server_groups }}" snapshots: "{{ item.snapshots }}" volumes: "{{ item.volumes }}" volumes_types: volumes_lvm: "{{ item.volumes_lvm }}" snapshots_types: snapshots_lvm: "{{ item.snapshots_lvm }}" gigabytes_types: gigabytes_lvm: "{{ item.gigabytes_lvm }}" with_items: - "{{ projects }}" when: item.state == "present" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_quotas dictionary \| Regardless if changes where made or not \| Dictionary describing the project quota. Sample: {'openstack\_quotas': {'compute': {'cores': 150, 'fixed\_ips': -1, 'floating\_ips': 10, 'injected\_file\_content\_bytes': 10240, 'injected\_file\_path\_bytes': 255, 'injected\_files': 5, 'instances': 100, 'key\_pairs': 100, 'metadata\_items': 128, 'ram': 153600, 'security\_group\_rules': 20, 'security\_groups': 10, 'server\_group\_members': 10, 'server\_groups': 10}, 'network': {'floatingip': 50, 'loadbalancer': 10, 'network': 10, 'pool': 10, 'port': 160, 'rbac\_policy': 10, 'router': 10, 'security\_group': 10, 'security\_group\_rule': 100, 'subnet': 10, 'subnetpool': -1}, 'volume': {'backup\_gigabytes': 1000, 'backups': 10, 'gigabytes': 1000, 'gigabytes\_lvm': -1, 'per\_volume\_gigabytes': -1, 'snapshots': 10, 'snapshots\_lvm': -1, 'volumes': 10, 'volumes\_lvm': -1}}} \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.baremetal_node – Create/Delete Bare Metal Resources from OpenStack openstack.cloud.baremetal\_node – Create/Delete Bare Metal Resources from OpenStack =================================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.baremetal_node`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or Remove Ironic nodes from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * jsonpatch * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| bios\_interface string \| \| The bios interface for this node, e.g. "no-bios". \| \| boot\_interface string \| \| The boot interface for this node, e.g. "pxe". \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| chassis\_uuid string \| \| Associate the node with a pre-defined chassis. \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| console\_interface string \| \| The console interface for this node, e.g. "no-console". \| \| deploy\_interface string \| \| The deploy interface for this node, e.g. "iscsi". \| \| driver string \| \| The name of the Ironic Driver to use with this node. Required when state=present \| \| driver\_info dictionary / required \| \| Information for this server's driver. Will vary based on which driver is in use. Any sub-field which is populated will be validated during creation. For compatibility reasons sub-fields `power`, `deploy`, `management` and `console` are flattened. \| \| inspect\_interface string \| \| The interface used for node inspection, e.g. "no-inspect". \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| ironic\_url string \| \| If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with "auth" and "auth\_type" settings set to None. \| \| management\_interface string \| \| The interface for out-of-band management of this node, e.g. "ipmitool". \| \| name string \| \| unique name identifier to be given to the resource. \| \| network\_interface string \| \| The network interface provider to use when describing connections for this node. \| \| nics list / elements=dictionary / required \| \| A list of network interface cards, eg, " - mac: aa:bb:cc:aa:bb:cc" \| \| \| mac string / required \| \| The MAC address of the network interface card. \| \| power\_interface string \| \| The interface used to manage power actions on this node, e.g. "ipmitool". \| \| properties dictionary \| \| Definition of the physical characteristics of this server, used for scheduling purposes \| \| \| capabilities string \| Default:"" \| special capabilities for the node, such as boot\_option, node\_role etc (see <https://docs.openstack.org/ironic/latest/install/advanced.html> for more information) \| \| \| cpu\_arch string \| Default:"x86\_64" \| CPU architecture (x86\_64, i686, ...) \| \| \| cpus string \| Default:1 \| Number of CPU cores this machine has \| \| \| disk\_size string \| Default:1 \| size of first storage device in this machine (typically /dev/sda), in GB \| \| \| ram string \| Default:1 \| amount of RAM this machine has, in MB \| \| \| root\_device string \| Default:"" \| Root disk device hints for deployment. See <https://docs.openstack.org/ironic/latest/install/advanced.html#specifying-the-disk-for-deployment-root-device-hints> for allowed hints. \| \| raid\_interface string \| \| Interface used for configuring raid on this node. \| \| region\_name string \| \| Name of the region. \| \| rescue\_interface string \| \| Interface used for node rescue, e.g. "no-rescue". \| \| resource\_class string \| \| The specific resource type to which this node belongs. \| \| skip\_update\_of\_masked\_password boolean \| Choices:* no * yes \| Allows the code that would assert changes to nodes to skip the update if the change is a single line consisting of the password field. As of Kilo, by default, passwords are always masked to API requests, which means the logic as a result always attempts to re-assert the password field. `skip_update_of_driver_password` is deprecated alias and will be removed in openstack.cloud 2.0.0. aliases: skip\_update\_of\_driver\_password \| \| state string \| Choices:* present ← * absent \| Indicates desired state of the resource \| \| storage\_interface string \| \| Interface used for attaching and detaching volumes on this node, e.g. "cinder". \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| uuid string \| \| globally unique identifier (UUID) to be given to the resource. Will be auto-generated if not specified, and name is specified. Definition of a UUID will always take precedence to a name value. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| vendor\_interface string \| \| Interface for all vendor-specific actions on this node, e.g. "no-vendor". \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Enroll a node with some basic properties and driver info - openstack.cloud.baremetal_node: cloud: "devstack" driver: "pxe_ipmitool" uuid: "00000000-0000-0000-0000-000000000002" properties: cpus: 2 cpu_arch: "x86_64" ram: 8192 disk_size: 64 capabilities: "boot_option:local" root_device: wwn: "0x4000cca77fc4dba1" nics: - mac: "aa:bb:cc:aa:bb:cc" - mac: "dd:ee:ff:dd:ee:ff" driver_info: ipmi_address: "1.2.3.4" ipmi_username: "admin" ipmi_password: "adminpass" chassis_uuid: "00000000-0000-0000-0000-000000000001" ``` ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.subnet – Add/Remove subnet to an OpenStack network openstack.cloud.subnet – Add/Remove subnet to an OpenStack network ================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.subnet`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add or Remove a subnet to an OpenStack network Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allocation\_pool\_end string \| \| From the subnet pool the last IP that should be assigned to the virtual machines. \| \| allocation\_pool\_start string \| \| From the subnet pool the starting address from which the IP should be allocated. \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| cidr string \| \| The CIDR representation of the subnet that should be assigned to the subnet. Required when state is 'present' and a subnetpool is not specified. \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| dns\_nameservers list / elements=string \| \| List of DNS nameservers for this subnet. \| \| enable\_dhcp boolean \| Choices:* no * yes ← \| Whether DHCP should be enabled for this subnet. \| \| extra\_specs dictionary \| Default:{} \| Dictionary with extra key/value pairs passed to the API \| \| gateway\_ip string \| \| The ip that would be assigned to the gateway for this subnet \| \| host\_routes list / elements=dictionary \| \| A list of host route dictionaries for the subnet. \| \| \| destination string / required \| \| The destination network (CIDR). \| \| \| nexthop string / required \| \| The next hop (aka gateway) for the destination. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| ip\_version string \| Choices:* 4 * 6 Default:4 \| The IP version of the subnet 4 or 6 \| \| ipv6\_address\_mode string \| Choices:* dhcpv6-stateful * dhcpv6-stateless * slaac \| IPv6 address mode \| \| ipv6\_ra\_mode string \| Choices:* dhcpv6-stateful * dhcpv6-stateless * slaac \| IPv6 router advertisement mode \| \| name string / required \| \| The name of the subnet that should be created. Although Neutron allows for non-unique subnet names, this module enforces subnet name uniqueness. \| \| network\_name string \| \| Name of the network to which the subnet should be attached Required when state is 'present' \| \| no\_gateway\_ip boolean \| Choices:* no ← * yes \| The gateway IP would not be assigned for this subnet \| \| project string \| \| Project name or ID containing the subnet (name admin-only) \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| use\_default\_subnetpool boolean \| Choices:* no ← * yes \| Use the default subnetpool for ip\_version to obtain a CIDR. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a new (or update an existing) subnet on the specified network - openstack.cloud.subnet: state: present network_name: network1 name: net1subnet cidr: 192.168.0.0/24 dns_nameservers: - 8.8.8.7 - 8.8.8.8 host_routes: - destination: 0.0.0.0/0 nexthop: 12.34.56.78 - destination: 192.168.0.0/24 nexthop: 192.168.0.1 # Delete a subnet - openstack.cloud.subnet: state: absent name: net1subnet # Create an ipv6 stateless subnet - openstack.cloud.subnet: state: present name: intv6 network_name: internal ip_version: 6 cidr: 2db8:1::/64 dns_nameservers: - 2001:4860:4860::8888 - 2001:4860:4860::8844 ipv6_ra_mode: dhcpv6-stateless ipv6_address_mode: dhcpv6-stateless ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.networks_info – Retrieve information about one or more OpenStack networks. openstack.cloud.networks\_info – Retrieve information about one or more OpenStack networks. =========================================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.networks_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve information about one or more networks from OpenStack. * This module was called `openstack.cloud.networks_facts` before Ansible 2.9, returning `ansible_facts`. Note that the [openstack.cloud.networks\_info](#ansible-collections-openstack-cloud-networks-info-module) module no longer returns `ansible_facts`! Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| filters dictionary \| \| A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name or ID of the Network \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Gather information about previously created networks openstack.cloud.networks_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject register: result - name: Show openstack networks debug: msg: "{{ result.openstack_networks }}" - name: Gather information about a previously created network by name openstack.cloud.networks_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject name: network1 register: result - name: Show openstack networks debug: msg: "{{ result.openstack_networks }}" - name: Gather information about a previously created network with filter # Note: name and filters parameters are Not mutually exclusive openstack.cloud.networks_info: auth: auth_url: https://identity.example.com username: user password: password project_name: someproject filters: tenant_id: 55e2ce24b2a245b09f181bf025724cbe subnets: - 057d4bdf-6d4d-4728-bb0f-5ac45a6f7400 - 443d4dc0-91d4-4998-b21c-357d10433483 register: result - name: Show openstack networks debug: msg: "{{ result.openstack_networks }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_networks complex \| always, but can be null \| has all the openstack information about the networks \| \| \| id string \| success \| Unique UUID. \| \| \| name string \| success \| Name given to the network. \| \| \| shared boolean \| success \| Network shared flag. \| \| \| status string \| success \| Network status. \| \| \| subnets list / elements=string \| success \| Subnet(s) included in this network. \| \| \| tenant\_id string \| success \| Tenant id associated with this network. \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.keypair – Add/Delete a keypair from OpenStack openstack.cloud.keypair – Add/Delete a keypair from OpenStack ============================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.keypair`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove key pair from OpenStack Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Name that has to be given to the key pair \| \| public\_key string \| \| The public key that would be uploaded to nova and injected into VMs upon creation. \| \| public\_key\_file string \| \| Path to local file containing ssh public key. Mutually exclusive with public\_key. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent * replace \| Should the resource be present or absent. If state is replace and the key exists but has different content, delete it and recreate it with the new content. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Creates a key pair with the running users public key - openstack.cloud.keypair: cloud: mordred state: present name: ansible_key public_key_file: /home/me/.ssh/id_rsa.pub # Creates a new key pair and the private key returned after the run. - openstack.cloud.keypair: cloud: rax-dfw state: present name: ansible_key ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| success \| Unique UUID. \| \| name string \| success \| Name given to the keypair. \| \| private\_key string \| Only when a keypair is generated for the user (e.g., when creating one and a public key is not specified). \| The private key value for the keypair. \| \| public\_key string \| success \| The public key value for the keypair. \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.openstack – OpenStack inventory source openstack.cloud.openstack – OpenStack inventory source ====================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.openstack`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Examples](#examples) Synopsis -------- * Get inventory hosts from OpenStack clouds * Uses openstack.(yml\|yaml) YAML configuration file to configure the inventory plugin * Uses standard clouds.yaml YAML configuration file to configure cloud credentials Requirements ------------ The below requirements are needed on the local controller node that executes this inventory. * openstacksdk >= 0.28 Parameters ---------- \| Parameter \| Choices/Defaults \| Configuration \| Comments \| \| --- \| --- \| --- \| --- \| \| all\_projects boolean \| Choices:* no ← * yes \| \| Lists servers from all projects \| \| cache boolean \| Choices:* no ← * yes \| ini entries: [inventory]cache = no env:ANSIBLE\_INVENTORY\_CACHE \| Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work. \| \| cache\_connection string \| \| ini entries: [defaults]fact\_caching\_connection = None [inventory]cache\_connection = None env:ANSIBLE\_CACHE\_PLUGIN\_CONNECTION env:ANSIBLE\_INVENTORY\_CACHE\_CONNECTION \| Cache connection data or path, read cache plugin documentation for specifics. \| \| cache\_plugin string \| Default:"memory" \| ini entries: [defaults]fact\_caching = memory [inventory]cache\_plugin = memory env:ANSIBLE\_CACHE\_PLUGIN env:ANSIBLE\_INVENTORY\_CACHE\_PLUGIN \| Cache plugin to use for the inventory's source data. \| \| cache\_prefix string \| Default:"ansible\_inventory\_" \| ini entries: [default]fact\_caching\_prefix = ansible\_inventory\_ [inventory]cache\_prefix = ansible\_inventory\_ env:ANSIBLE\_CACHE\_PLUGIN\_PREFIX env:ANSIBLE\_INVENTORY\_CACHE\_PLUGIN\_PREFIX \| Prefix to use for cache plugin files/tables \| \| cache\_timeout integer \| Default:3600 \| ini entries: [defaults]fact\_caching\_timeout = 3600 [inventory]cache\_timeout = 3600 env:ANSIBLE\_CACHE\_PLUGIN\_TIMEOUT env:ANSIBLE\_INVENTORY\_CACHE\_TIMEOUT \| Cache duration in seconds \| \| clouds\_yaml\_path list / elements=string \| \| env:OS\_CLIENT\_CONFIG\_FILE \| Override path to clouds.yaml file. If this value is given it will be searched first. The default path for the ansible inventory adds /etc/ansible/openstack.yaml and /etc/ansible/openstack.yml to the regular locations documented at https://docs.openstack.org/os-client-config/latest/user/configuration.html#config-files \| \| compose dictionary \| Default:{} \| \| Create vars from jinja2 expressions. \| \| expand\_hostvars boolean \| Choices:* no ← * yes \| \| Run extra commands on each host to fill in additional information about the host. May interrogate cinder and neutron and can be expensive for people with many hosts. (Note, the default value of this is opposite from the default old openstack.py inventory script's option expand\_hostvars) \| \| fail\_on\_errors boolean \| Choices:* no ← * yes \| \| Causes the inventory to fail and return no hosts if one cloud has failed (for example, bad credentials or being offline). When set to False, the inventory will return as many hosts as it can from as many clouds as it can contact. (Note, the default value of this is opposite from the old openstack.py inventory script's option fail\_on\_errors) \| \| groups dictionary \| Default:{} \| \| Add hosts to group based on Jinja2 conditionals. \| \| inventory\_hostname string \| Choices:* name ← * uuid \| \| What to register as the inventory hostname. If set to 'uuid' the uuid of the server will be used and a group will be created for the server name. If set to 'name' the name of the server will be used unless there are more than one server with the same name in which case the 'uuid' logic will be used. Default is to do 'name', which is the opposite of the old openstack.py inventory script's option use\_hostnames) \| \| keyed\_groups list / elements=string \| Default:[] \| \| Add hosts to group based on the values of a variable. \| \| leading\_separator boolean added in 2.11 of ansible.builtin \| Choices:* no * yes ← \| \| Use in conjunction with keyed\_groups. By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. This is because the default prefix is "" and the default separator is "\_". Set this option to False to omit the leading underscore (or other separator) if no prefix is given. If the group name is derived from a mapping the separator is still used to concatenate the items. To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. \| \| legacy\_groups boolean \| Choices:* no * yes ← \| \| Automatically create groups from host variables. \| \| only\_clouds list / elements=string \| Default:[] \| \| List of clouds from clouds.yaml to use, instead of using the whole list. \| \| plugin string / required \| Choices:* openstack * openstack.cloud.openstack \| \| token that ensures this is a source file for the 'openstack' plugin. \| \| private boolean \| Choices:* no ← * yes \| \| Use the private interface of each server, if it has one, as the host's IP in the inventory. This can be useful if you are running ansible inside a server in the cloud and would rather communicate to your servers over the private network. \| \| show\_all boolean \| Choices:* no ← * yes \| \| toggles showing all vms vs only those with a working IP \| \| strict boolean \| Choices:* no ← * yes \| \| If `yes` make invalid entries a fatal error, otherwise skip and continue. Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. \| \| use\_extra\_vars boolean added in 2.11 of ansible.builtin \| Choices:* no ← * yes \| ini entries: [inventory\_plugins]use\_extra\_vars = no env:ANSIBLE\_INVENTORY\_USE\_EXTRA\_VARS \| Merge extra vars into the available variables for composition (highest precedence). \| Examples -------- ``` # file must be named openstack.yaml or openstack.yml # Make the plugin behave like the default behavior of the old script plugin: openstack.cloud.openstack expand_hostvars: yes fail_on_errors: yes all_projects: yes ``` ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.compute_flavor – Manage OpenStack compute flavors openstack.cloud.compute\_flavor – Manage OpenStack compute flavors ================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.compute_flavor`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or remove flavors from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| disk integer \| Default:0 \| Size of local disk, in GB. \| \| ephemeral integer \| Default:0 \| Ephemeral space size, in GB. \| \| extra\_specs dictionary \| \| Metadata dictionary \| \| flavorid string \| Default:"auto" \| ID for the flavor. This is optional as a unique UUID will be assigned if a value is not specified. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| is\_public boolean \| Choices:* no * yes ← \| Make flavor accessible to the public. \| \| name string / required \| \| Flavor name. \| \| ram integer \| \| Amount of memory, in MB. \| \| region\_name string \| \| Name of the region. \| \| rxtx\_factor float \| Default:1.0 \| RX/TX factor. \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource. When state is 'present', then ram, vcpus, and disk are all required. There are no default values for those parameters. \| \| swap integer \| Default:0 \| Swap space size, in MB. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| vcpus integer \| \| Number of virtual CPUs. \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: "Create 'tiny' flavor with 1024MB of RAM, 1 virtual CPU, and 10GB of local disk, and 10GB of ephemeral." openstack.cloud.compute_flavor: cloud: mycloud state: present name: tiny ram: 1024 vcpus: 1 disk: 10 ephemeral: 10 - name: "Delete 'tiny' flavor" openstack.cloud.compute_flavor: cloud: mycloud state: absent name: tiny - name: Create flavor with metadata openstack.cloud.compute_flavor: cloud: mycloud state: present name: tiny ram: 1024 vcpus: 1 disk: 10 extra_specs: "quota:disk_read_iops_sec": 5000 "aggregate_instance_extra_specs:pinned": false ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| flavor complex \| On success when state is 'present' \| Dictionary describing the flavor. \| \| \| disk integer \| success \| Size of local disk, in GB. Sample: 10 \| \| \| ephemeral integer \| success \| Ephemeral space size, in GB. Sample: 10 \| \| \| extra\_specs dictionary \| success \| Flavor metadata Sample: {'aggregate\_instance\_extra\_specs:pinned': False, 'quota:disk\_read\_iops\_sec': 5000} \| \| \| id string \| success \| Flavor ID. Sample: 515256b8-7027-4d73-aa54-4e30a4a4a339 \| \| \| is\_public boolean \| success \| Make flavor accessible to the public. Sample: True \| \| \| name string \| success \| Flavor name. Sample: tiny \| \| \| ram integer \| success \| Amount of memory, in MB. Sample: 1024 \| \| \| swap integer \| success \| Swap space size, in MB. Sample: 100 \| \| \| vcpus integer \| success \| Number of virtual CPUs. Sample: 2 \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.identity_user_info – Retrieve information about one or more OpenStack users openstack.cloud.identity\_user\_info – Retrieve information about one or more OpenStack users ============================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.identity_user_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve information about a one or more OpenStack users * This module was called `openstack.cloud.identity_user_facts` before Ansible 2.9, returning `ansible_facts`. Note that the [openstack.cloud.identity\_user\_info](#ansible-collections-openstack-cloud-identity-user-info-module) module no longer returns `ansible_facts`! Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| domain string \| \| Name or ID of the domain containing the user if the cloud supports domains \| \| filters dictionary \| \| A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name or ID of the user \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Gather information about previously created users - openstack.cloud.identity_user_info: cloud: awesomecloud register: result - debug: msg: "{{ result.openstack_users }}" # Gather information about a previously created user by name - openstack.cloud.identity_user_info: cloud: awesomecloud name: demouser register: result - debug: msg: "{{ result.openstack_users }}" # Gather information about a previously created user in a specific domain - openstack.cloud.identity_user_info: cloud: awesomecloud name: demouser domain: admindomain register: result - debug: msg: "{{ result.openstack_users }}" # Gather information about a previously created user in a specific domain with filter - openstack.cloud.identity_user_info: cloud: awesomecloud name: demouser domain: admindomain filters: enabled: False register: result - debug: msg: "{{ result.openstack_users }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_users complex \| always, but can be null \| has all the OpenStack information about users \| \| \| default\_project\_id string \| success \| Default project ID of the user \| \| \| domain\_id string \| success \| Domain ID containing the user \| \| \| email string \| success \| Email of the user \| \| \| enabled boolean \| success \| Flag to indicate if the user is enabled \| \| \| id string \| success \| Unique UUID. \| \| \| name string \| success \| Name given to the user. \| \| \| username string \| success \| Username of the user \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.project_info – Retrieve information about one or more OpenStack projects openstack.cloud.project\_info – Retrieve information about one or more OpenStack projects ========================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.project_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Retrieve information about a one or more OpenStack projects * This module was called `openstack.cloud.project_facts` before Ansible 2.9, returning `ansible_facts`. Note that the [openstack.cloud.project\_info](#ansible-collections-openstack-cloud-project-info-module) module no longer returns `ansible_facts`! Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| domain string \| \| Name or ID of the domain containing the project if the cloud supports domains \| \| filters dictionary \| \| A dictionary of meta data to use for further filtering. Elements of this dictionary may be additional dictionaries. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name or ID of the project \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Gather information about previously created projects - openstack.cloud.project_info: cloud: awesomecloud register: result - debug: msg: "{{ result.openstack_projects }}" # Gather information about a previously created project by name - openstack.cloud.project_info: cloud: awesomecloud name: demoproject register: result - debug: msg: "{{ result.openstack_projects }}" # Gather information about a previously created project in a specific domain - openstack.cloud.project_info: cloud: awesomecloud name: demoproject domain: admindomain register: result - debug: msg: "{{ result.openstack_projects }}" # Gather information about a previously created project in a specific domain with filter - openstack.cloud.project_info: cloud: awesomecloud name: demoproject domain: admindomain filters: enabled: False register: result - debug: msg: "{{ result.openstack_projects }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| openstack\_projects complex \| always, but can be null \| has all the OpenStack information about projects \| \| \| description string \| success \| Description of the project \| \| \| domain\_id boolean \| success \| Domain ID containing the project (keystone v3 clouds only) \| \| \| enabled boolean \| success \| Flag to indicate if the project is enabled \| \| \| id string \| success \| Unique UUID. \| \| \| name string \| success \| Name given to the project. \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.host_aggregate – Manage OpenStack host aggregates openstack.cloud.host\_aggregate – Manage OpenStack host aggregates ================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.host_aggregate`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, update, or delete OpenStack host aggregates. If a aggregate with the supplied name already exists, it will be updated with the new name, new availability zone, new metadata and new list of hosts. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Availability zone to create aggregate into. \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| hosts list / elements=string \| \| List of hosts to set for an aggregate. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| metadata dictionary \| \| Metadata dict. \| \| name string / required \| \| Name of the aggregate. \| \| purge\_hosts boolean \| Choices:* no * yes ← \| Whether hosts not in hosts should be removed from the aggregate \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a host aggregate - openstack.cloud.host_aggregate: cloud: mycloud state: present name: db_aggregate hosts: - host1 - host2 metadata: type: dbcluster # Add an additional host to the aggregate - openstack.cloud.host_aggregate: cloud: mycloud state: present name: db_aggregate hosts: - host3 purge_hosts: false metadata: type: dbcluster # Delete an aggregate - openstack.cloud.host_aggregate: cloud: mycloud state: absent name: db_aggregate ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.federation_idp – manage a federation Identity Provider openstack.cloud.federation\_idp – manage a federation Identity Provider ======================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.federation_idp`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manage a federation Identity Provider. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk >= 0.12.0 * openstacksdk >= 0.44 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| The description of the Identity Provider. \| \| domain\_id string \| \| The ID of a domain that is associated with the Identity Provider. Federated users that authenticate with the Identity Provider will be created under the domain specified. Required when creating a new Identity Provider. \| \| enabled boolean \| Choices:* no * yes \| Whether the Identity Provider is enabled or not. Will default to `true` when creating a new Identity Provider. aliases: is\_enabled \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| The name of the Identity Provider. aliases: id \| \| region\_name string \| \| Name of the region. \| \| remote\_ids list / elements=string \| \| List of the unique Identity Provider's remote IDs. Will default to an empty list when creating a new Identity Provider. \| \| state string \| Choices:* present ← * absent \| Whether the Identity Provider should be `present` or `absent`. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Create an identity provider openstack.cloud.federation_idp: cloud: example_cloud name: example_provider domain_id: 0123456789abcdef0123456789abcdef description: 'My example IDP' remote_ids: - 'https://auth.example.com/auth/realms/ExampleRealm' - name: Delete an identity provider openstack.cloud.federation_idp: cloud: example_cloud name: example_provider state: absent ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.network – Creates/removes networks from OpenStack openstack.cloud.network – Creates/removes networks from OpenStack ================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.network`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or remove network from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| admin\_state\_up boolean \| Choices:* no * yes ← \| Whether the state should be marked as up or down. \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| dns\_domain string \| \| The DNS domain value to set. Requires openstacksdk>=0.29. Network will use Openstack defaults if this option is not provided. \| \| external boolean \| Choices:* no ← * yes \| Whether this network is externally accessible. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| mtu\_size integer \| \| The maximum transmission unit (MTU) value to address fragmentation. Network will use OpenStack defaults if this option is not provided. Requires openstacksdk>=0.18. aliases: mtu \| \| name string / required \| \| Name to be assigned to the network. \| \| port\_security\_enabled boolean \| Choices:* no * yes \| Whether port security is enabled on the network or not. Network will use OpenStack defaults if this option is not utilised. Requires openstacksdk>=0.18. \| \| project string \| \| Project name or ID containing the network (name admin-only) \| \| provider\_network\_type string \| \| The type of physical network that maps to this network resource. \| \| provider\_physical\_network string \| \| The physical network where this network object is implemented. \| \| provider\_segmentation\_id integer \| \| An isolated segment on the physical network. The network\_type attribute defines the segmentation model. For example, if the network\_type value is vlan, this ID is a vlan identifier. If the network\_type value is gre, this ID is a gre key. \| \| region\_name string \| \| Name of the region. \| \| shared boolean \| Choices:* no ← * yes \| Whether this network is shared or not. \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create an externally accessible network named 'ext_network'. - openstack.cloud.network: cloud: mycloud state: present name: ext_network external: true ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| network complex \| On success when state is 'present'. \| Dictionary describing the network. \| \| \| admin\_state\_up boolean \| success \| The administrative state of the network. Sample: True \| \| \| dns\_domain string \| success \| The DNS domain of a network resource. Sample: sample.openstack.org. \| \| \| id string \| success \| Network ID. Sample: 4bb4f9a5-3bd2-4562-bf6a-d17a6341bb56 \| \| \| mtu integer \| success \| The MTU of a network resource. \| \| \| name string \| success \| Network name. Sample: ext\_network \| \| \| port\_security\_enabled boolean \| success \| The port security status Sample: True \| \| \| provider:network\_type string \| success \| The type of physical network that maps to this network resource. Sample: vlan \| \| \| provider:physical\_network string \| success \| The physical network where this network object is implemented. Sample: my\_vlan\_net \| \| \| provider:segmentation\_id string \| success \| An isolated segment on the physical network. Sample: 101 \| \| \| router:external boolean \| success \| Indicates whether this network is externally accessible. Sample: True \| \| \| shared boolean \| success \| Indicates whether this network is shared across all tenants. \| \| \| status string \| success \| Network status. Sample: ACTIVE \| \| \| subnets list / elements=string \| success \| The associated subnets. \| \| \| tenant\_id string \| success \| The tenant ID. Sample: 06820f94b9f54b119636be2728d216fc \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.server_metadata – Add/Update/Delete Metadata in Compute Instances from OpenStack openstack.cloud.server\_metadata – Add/Update/Delete Metadata in Compute Instances from OpenStack ================================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.server_metadata`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add, Update or Remove metadata in compute instances from OpenStack. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Availability zone in which to create the snapshot. \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| meta dictionary / required \| \| A list of key value pairs that should be provided as a metadata to the instance or a string containing a list of key-value pairs. Eg: meta: "key1=value1,key2=value2" \| \| region\_name string \| \| Name of the region. \| \| server string / required \| \| Name of the instance to update the metadata aliases: name \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Creates or updates hostname=test1 as metadata of the server instance vm1 - name: add metadata to compute instance hosts: localhost tasks: - name: add metadata to instance openstack.cloud.server_metadata: state: present auth: auth_url: https://openstack-api.example.com:35357/v2.0/ username: admin password: admin project_name: admin name: vm1 meta: hostname: test1 group: group1 # Removes the keys under meta from the instance named vm1 - name: delete metadata from compute instance hosts: localhost tasks: - name: delete metadata from instance openstack.cloud.server_metadata: state: absent auth: auth_url: https://openstack-api.example.com:35357/v2.0/ username: admin password: admin project_name: admin name: vm1 meta: hostname: group: ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| metadata dictionary \| success \| The metadata of compute instance after the change Sample: {'key1': 'value1', 'key2': 'value2'} \| \| server\_id string \| success \| The compute instance id where the change was made Sample: 324c4e91-3e03-4f62-9a4d-06119a8a8d16 \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.federation_mapping – Manage a federation mapping openstack.cloud.federation\_mapping – Manage a federation mapping ================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.federation_mapping`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manage a federation mapping. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk >= 0.12.0 * openstacksdk >= 0.44 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| The name of the mapping to manage. aliases: id \| \| region\_name string \| \| Name of the region. \| \| rules list / elements=dictionary \| \| The rules that comprise the mapping. These are pairs of local and remote definitions. For more details on how these work please see the OpenStack documentation <https://docs.openstack.org/keystone/latest/admin/federation/mapping_combinations.html>. Required if state=present \| \| \| local list / elements=dictionary / required \| \| Information on what local attributes will be mapped. \| \| \| remote list / elements=dictionary / required \| \| Information on what remote attributes will be mapped. \| \| state string \| Choices:* present ← * absent \| Whether the mapping should be `present` or `absent`. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Create a new mapping openstack.cloud.federation_mapping: cloud: example_cloud name: example_mapping rules: - local: - user: name: '{0}' - group: id: '0cd5e9' remote: - type: UserName - type: orgPersonType any_one_of: - Contractor - SubContractor - name: Delete a mapping openstack.cloud.federation_mapping: name: example_mapping state: absent ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.security_group_info – Lists security groups openstack.cloud.security\_group\_info – Lists security groups ============================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.security_group_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * List security groups Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| any\_tags list / elements=string \| \| A list of tags to filter the list result by. Resources that match any tag in this list will be returned. \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| description string \| \| Description of the security group \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name or id of the security group. \| \| not\_any\_tags list / elements=string \| \| A list of tags to filter the list result by. Resources that match any tag in this list will be excluded. \| \| not\_tags list / elements=string \| \| A list of tags to filter the list result by. Resources that match all tags in this list will be excluded. \| \| project\_id string \| \| Specifies the project id as filter criteria \| \| region\_name string \| \| Name of the region. \| \| revision\_number integer \| \| Filter the list result by the revision number of the resource. \| \| tags list / elements=string \| \| A list of tags to filter the list result by. Resources that match all tags in this list will be returned. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Get specific security group - openstack.cloud.security_group_info: cloud: "{{ cloud }}" name: "{{ my_sg }}" register: sg # Get all security groups - openstack.cloud.security_group_info: cloud: "{{ cloud }}" register: sg ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| security\_groups complex \| On Success. \| List of dictionaries describing security groups. \| \| \| created\_at string \| success \| Creation time of the security group Sample: yyyy-mm-dd hh:mm:ss \| \| \| description string \| success \| Description of the security group Sample: My security group \| \| \| id string \| success \| ID of the security group Sample: d90e55ba-23bd-4d97-b722-8cb6fb485d69 \| \| \| name string \| success \| Name of the security group. Sample: my-sg \| \| \| project\_id string \| success \| Project ID where the security group is located in. Sample: 25d24fc8-d019-4a34-9fff-0a09fde6a567 \| \| \| security\_group\_rules list / elements=string \| success \| Specifies the security group rule list Sample: [{'description': None, 'direction': 'ingress', 'ethertype': 'IPv4', 'id': 'd90e55ba-23bd-4d97-b722-8cb6fb485d69', 'port\_range\_max': None, 'port\_range\_min': None, 'protocol': None, 'remote\_group\_id': '0431c9c5-1660-42e0-8a00-134bec7f03e2', 'remote\_ip\_prefix': None, 'security\_group\_id': '0431c9c5-1660-42e0-8a00-134bec7f03e2', 'tenant\_id': 'bbfe8c41dd034a07bebd592bf03b4b0c'}, {'description': None, 'direction': 'egress', 'ethertype': 'IPv4', 'id': 'aecff4d4-9ce9-489c-86a3-803aedec65f7', 'port\_range\_max': None, 'port\_range\_min': None, 'protocol': None, 'remote\_group\_id': None, 'remote\_ip\_prefix': None, 'security\_group\_id': '0431c9c5-1660-42e0-8a00-134bec7f03e2', 'tenant\_id': 'bbfe8c41dd034a07bebd592bf03b4b0c'}] \| \| \| updated\_at string \| success \| Update time of the security group Sample: yyyy-mm-dd hh:mm:ss \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.group_assignment – Associate OpenStack Identity users and groups openstack.cloud.group\_assignment – Associate OpenStack Identity users and groups ================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.group_assignment`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add and remove users from groups Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| group string / required \| \| Name or id for the group. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the user be present or absent in the group \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| user string / required \| \| Name or id for the user \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Add the demo user to the demo group - openstack.cloud.group_assignment: cloud: mycloud user: demo group: demo ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.baremetal_node_action – Activate/Deactivate Bare Metal Resources from OpenStack openstack.cloud.baremetal\_node\_action – Activate/Deactivate Bare Metal Resources from OpenStack ================================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.baremetal_node_action`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Deploy to nodes controlled by Ironic. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| config\_drive raw \| \| A configdrive file or HTTP(S) URL that will be passed along to the node. \| \| deploy string \| Default:"yes" \| Indicates if the resource should be deployed. Allows for deployment logic to be disengaged and control of the node power or maintenance state to be changed. \| \| instance\_info dictionary \| \| Definition of the instance information which is used to deploy the node. This information is only required when an instance is set to present. \| \| \| image\_checksum string \| \| The checksum of image\_source. \| \| \| image\_disk\_format string \| \| The type of image that has been requested to be deployed. \| \| \| image\_source string \| \| An HTTP(S) URL where the image can be retrieved from. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| ironic\_url string \| \| If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with "auth" and "auth\_type" settings set to None. \| \| maintenance string \| \| A setting to allow the direct control if a node is in maintenance mode. maintenance can be `'yes'`, `'no'`, `'True'`, or `'False'`. \| \| maintenance\_reason string \| \| A string expression regarding the reason a node is in a maintenance mode. \| \| name string \| \| Name of the node to create. \| \| power string \| Default:"present" \| A setting to allow power state to be asserted allowing nodes that are not yet deployed to be powered on, and nodes that are deployed to be powered off. power can be `'present'`, `'absent'`, `'maintenance'` or `'off'`. \| \| region\_name string \| \| Name of the region. \| \| state string \| Default:"present" \| Indicates desired state of the resource. state can be `'present'`, `'absent'`, `'maintenance'` or `'off'`. \| \| timeout integer \| Default:1800 \| An integer value representing the number of seconds to wait for the node activation or deactivation to complete. \| \| uuid string \| \| globally unique identifier (UUID) to be given to the resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no ← * yes \| A boolean value instructing the module to wait for node activation or deactivation to complete before returning. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Activate a node by booting an image with a configdrive attached - openstack.cloud.baremetal_node_action: cloud: "openstack" uuid: "d44666e1-35b3-4f6b-acb0-88ab7052da69" state: present power: present deploy: True maintenance: False config_drive: "http://192.168.1.1/host-configdrive.iso" instance_info: image_source: "http://192.168.1.1/deploy_image.img" image_checksum: "356a6b55ecc511a20c33c946c4e678af" image_disk_format: "qcow" delegate_to: localhost # Activate a node by booting an image with a configdrive json object - openstack.cloud.baremetal_node_action: uuid: "d44666e1-35b3-4f6b-acb0-88ab7052da69" auth_type: None ironic_url: "http://192.168.1.1:6385/" config_drive: meta_data: hostname: node1 public_keys: default: ssh-rsa AAA...BBB== instance_info: image_source: "http://192.168.1.1/deploy_image.img" image_checksum: "356a6b55ecc511a20c33c946c4e678af" image_disk_format: "qcow" delegate_to: localhost ``` ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.object_container – Manage Swift container. openstack.cloud.object\_container – Manage Swift container. =========================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.object_container`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage Swift container. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| container string / required \| \| Name of a container in Swift. \| \| delete\_with\_all\_objects boolean \| Choices:* no ← * yes \| Whether the container should be deleted with all objects or not. Without this parameter set to "true", an attempt to delete a container that contains objects will fail. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| keys list / elements=string \| \| Keys from 'metadata' to be deleted. \| \| metadata dictionary \| \| Key/value pairs to be set as metadata on the container. If a container doesn't exist, it will be created. Both custom and system metadata can be set. Custom metadata are keys and values defined by the user. The system metadata keys are content\_type, content\_encoding, content\_disposition, delete\_after, delete\_at, is\_content\_type\_detected \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Whether resource should be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create empty container - openstack.cloud.object_container: container: "new-container" state: present # Set metadata for container - openstack.cloud.object_container: container: "new-container" metadata: "Cache-Control='no-cache'" # Delete some keys from metadata of a container - openstack.cloud.object_container: container: "new-container" keys: - content_type # Delete container - openstack.cloud.object_container: container: "new-container" state: absent # Delete container and its objects - openstack.cloud.object_container: container: "new-container" delete_with_all_objects: true state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| container dictionary \| On success when `state=present` \| Specifies the container. Sample: {'bytes': 5449, 'bytes\_used': 5449, 'content\_type': None, 'count': 1, 'id': 'otc', 'if\_none\_match': None, 'is\_content\_type\_detected': None, 'is\_newest': None, 'meta\_temp\_url\_key': None, 'meta\_temp\_url\_key\_2': None, 'name': 'otc', 'object\_count': 1, 'read\_ACL': None, 'sync\_key': None, 'sync\_to': None, 'timestamp': None, 'versions\_location': None, 'write\_ACL': None} \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.keystone_federation_protocol_info – get information about federation Protocols openstack.cloud.keystone\_federation\_protocol\_info – get information about federation Protocols ================================================================================================= Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.keystone_federation_protocol_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Get information about federation Protocols. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk >= 0.12.0 * openstacksdk >= 0.44 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| idp\_id string / required \| \| The name of the Identity Provider this Protocol is associated with. aliases: idp\_name \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| The name of the Protocol. aliases: id \| \| region\_name string \| \| Name of the region. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - name: Describe a protocol openstack.cloud.keystone_federation_protocol_info: cloud: example_cloud name: example_protocol idp_id: example_idp mapping_name: example_mapping - name: Describe all protocols attached to an IDP openstack.cloud.keystone_federation_protocol_info: cloud: example_cloud idp_id: example_idp ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.loadbalancer – Add/Delete load balancer from OpenStack Cloud openstack.cloud.loadbalancer – Add/Delete load balancer from OpenStack Cloud ============================================================================ Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.loadbalancer`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or Remove load balancer from the OpenStack load-balancer service(Octavia). Load balancer update is not supported for now. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| auto\_public\_ip boolean \| Choices:* no ← * yes \| Allocate a public IP address and associate with the VIP automatically. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| delete\_public\_ip boolean \| Choices:* no ← * yes \| When `state=absent` and this option is true, any public IP address associated with the VIP will be deleted along with the load balancer. \| \| flavor string \| \| The flavor of the load balancer. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| listeners list / elements=dictionary \| \| A list of listeners that attached to the load balancer. \| \| \| allowed\_cidrs string \| Default:[] \| A list of IPv4, IPv6 or mix of both CIDRs to be allowed access to the listener. The default is all allowed. When a list of CIDRs is provided, the default switches to deny all. Ignored on unsupported Octavia versions (less than 2.12) \| \| \| name string \| \| The listener name or ID. \| \| \| pool string \| \| The pool attached to the listener. \| \| \| \| lb\_algorithm string \| Default:"ROUND\_ROBIN" \| The load balancing algorithm for the pool. \| \| \| \| members string \| \| A list of members that added to the pool. \| \| \| \| \| address string \| \| The IP address of the member. \| \| \| \| \| name string \| \| The member name or ID. \| \| \| \| \| protocol\_port string \| Default:80 \| The protocol port number for the member. \| \| \| \| \| subnet string \| \| The name or ID of the subnet the member service is accessible from. \| \| \| \| name string \| \| The pool name or ID. \| \| \| \| protocol string \| Default:"HTTP" \| The protocol for the pool. \| \| \| protocol string \| Default:"HTTP" \| The protocol for the listener. \| \| \| protocol\_port string \| Default:80 \| The protocol port number for the listener. \| \| name string / required \| \| The name of the load balancer. \| \| public\_ip\_address string \| \| Public IP address associated with the VIP. \| \| public\_network string \| \| The name or ID of a Neutron external network. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| The amount of time the module should wait. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| vip\_address string \| \| IP address of the load balancer virtual IP. \| \| vip\_network string \| \| The name or id of the network for the virtual IP of the load balancer. One of vip\_network, vip\_subnet, or vip\_port must be specified for creation. \| \| vip\_port string \| \| The name or id of the load balancer virtual IP port. One of vip\_network, vip\_subnet, or vip\_port must be specified for creation. \| \| vip\_subnet string \| \| The name or id of the subnet for the virtual IP of the load balancer. One of vip\_network, vip\_subnet, or vip\_port must be specified for creation. \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the load balancer to be created or deleted. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a load balancer by specifying the VIP subnet. - openstack.cloud.loadbalancer: auth: auth_url: https://identity.example.com username: admin password: passme project_name: admin state: present name: my_lb vip_subnet: my_subnet timeout: 150 # Create a load balancer by specifying the VIP network and the IP address. - openstack.cloud.loadbalancer: auth: auth_url: https://identity.example.com username: admin password: passme project_name: admin state: present name: my_lb vip_network: my_network vip_address: 192.168.0.11 # Create a load balancer together with its sub-resources in the 'all in one' # way. A public IP address is also allocated to the load balancer VIP. - openstack.cloud.loadbalancer: auth: auth_url: https://identity.example.com username: admin password: passme project_name: admin name: lingxian_test state: present vip_subnet: kong_subnet auto_public_ip: yes public_network: public listeners: - name: lingxian_80 protocol: TCP protocol_port: 80 pool: name: lingxian_80_pool protocol: TCP members: - name: mywebserver1 address: 192.168.2.81 protocol_port: 80 subnet: webserver_subnet - name: lingxian_8080 protocol: TCP protocol_port: 8080 pool: name: lingxian_8080-pool protocol: TCP members: - name: mywebserver2 address: 192.168.2.82 protocol_port: 8080 wait: yes timeout: 600 # Delete a load balancer(and all its related resources) - openstack.cloud.loadbalancer: auth: auth_url: https://identity.example.com username: admin password: passme project_name: admin state: absent name: my_lb # Delete a load balancer(and all its related resources) together with the # public IP address(if any) attached to it. - openstack.cloud.loadbalancer: auth: auth_url: https://identity.example.com username: admin password: passme project_name: admin state: absent name: my_lb delete_public_ip: yes ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| id string \| On success when `state=present` \| The load balancer UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| loadbalancer complex \| On success when `state=present` \| Dictionary describing the load balancer. \| \| \| id string \| success \| Unique UUID. Sample: 39007a7e-ee4f-4d13-8283-b4da2e037c69 \| \| \| is\_admin\_state\_up boolean \| success \| The administrative state of the load balancer. Sample: True \| \| \| listeners list / elements=string \| success \| The associated listener IDs, if any. Sample: [{'id': '7aa1b380-beec-459c-a8a7-3a4fb6d30645'}, {'id': '692d06b8-c4f8-4bdb-b2a3-5a263cc23ba6'}] \| \| \| name string \| success \| Name given to the load balancer. Sample: lingxian\_test \| \| \| operating\_status string \| success \| The operating status of the load balancer. Sample: ONLINE \| \| \| pools list / elements=string \| success \| The associated pool IDs, if any. Sample: [{'id': '27b78d92-cee1-4646-b831-e3b90a7fa714'}, {'id': 'befc1fb5-1992-4697-bdb9-eee330989344'}] \| \| \| provisioning\_status string \| success \| The provisioning status of the load balancer. Sample: ACTIVE \| \| \| public\_vip\_address string \| success \| The load balancer public VIP address. Sample: 10.17.8.254 \| \| \| vip\_address string \| success \| The load balancer virtual IP address. Sample: 192.168.2.88 \| \| \| vip\_network\_id string \| success \| Network ID the load balancer virtual IP port belongs in. Sample: f171db43-56fd-41cf-82d7-4e91d741762e \| \| \| vip\_port\_id string \| success \| The load balancer virtual IP port ID. Sample: 2061395c-1c01-47ab-b925-c91b93df9c1d \| \| \| vip\_subnet\_id string \| success \| Subnet ID the load balancer virtual IP port belongs in. Sample: c53e3c70-9d62-409a-9f71-db148e7aa853 \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible openstack.cloud.volume_info – Retrive information about volumes openstack.cloud.volume\_info – Retrive information about volumes ================================================================ Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.volume_info`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get information about block storage in openstack Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| all\_projects boolean \| Choices:* no * yes \| Whether return the volumes in all projects \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| details boolean \| Choices:* no * yes \| Whether to provide additional information about volumes \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string \| \| Name of the volume as a string. \| \| region\_name string \| \| Name of the region. \| \| status string \| \| Value of the status of the volume so that you can filter on "available" for example \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` - openstack.cloud.volume_info: - openstack.cloud.volume_info: name: myvolume - openstack.cloud.volume_info: all_projects: true - openstack.cloud.volume_info: all_projects: true details: true ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| volumes list / elements=dictionary \| always \| Volumes in project Sample: [{'attachments': [], 'availability\_zone': 'nova', 'consistency\_group\_id': None, 'created\_at': '2017-11-15T10:51:19.000000', 'description': '', 'extended\_replication\_status': None, 'host': None, 'id': '103ac6ed-527f-4781-8484-7ff4467e34f5', 'image\_id': None, 'is\_bootable': True, 'is\_encrypted': False, 'links': [{'href': 'https://...', 'rel': 'self'}, {'href': 'https://...', 'rel': 'bookmark'}], 'location': {'cloud': 'cloud', 'project': {'domain\_id': None, 'domain\_name': 'Default', 'id': 'cfe04702154742fc964d9403c691c76e', 'name': 'username'}, 'region\_name': 'regionOne', 'zone': 'nova'}, 'metadata': {'readonly': 'False'}, 'migration\_id': None, 'migration\_status': None, 'name': '', 'project\_id': 'cab34702154a42fc96ed9403c691c76e', 'replication\_driver\_data': None, 'replication\_status': 'disabled', 'size': 9, 'snapshot\_id': None, 'source\_volume\_id': None, 'status': 'available', 'volume\_image\_metadata': {'checksum': 'a14e113deeee3a3392462f167ed28cb5', 'container\_format': 'bare', 'disk\_format': 'raw', 'family': 'centos-7', 'image\_id': 'afcf3320-1bf8-4a9a-a24d-5abd639a6e33', 'image\_name': 'CentOS-7-x86\_64-GenericCloud-1708', 'latest': 'centos-7-latest', 'min\_disk': '0', 'min\_ram': '0', 'official': 'True', 'official-image': 'True', 'size': '8589934592'}, 'volume\_type': None}] \| ### Authors * Sagi Shnaidman (@sshnaidm) ansible openstack.cloud.server_action – Perform actions on Compute Instances from OpenStack openstack.cloud.server\_action – Perform actions on Compute Instances from OpenStack ==================================================================================== Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.server_action`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Perform server actions on an existing compute instance from OpenStack. This module does not return any data other than changed true/false. When action is ‘rebuild’, then image parameter is required. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| action string / required \| Choices:* stop * start * pause * unpause * lock * unlock * suspend * resume * rebuild * shelve * shelve\_offload * unshelve \| Perform the given action. The lock and unlock actions always return changed as the servers API does not provide lock status. \| \| admin\_password string \| \| Admin password for server to rebuild \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| image string \| \| Image the server should be rebuilt with \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| region\_name string \| \| Name of the region. \| \| server string / required \| \| Name or ID of the instance \| \| timeout integer \| Default:180 \| The amount of time the module should wait for the instance to perform the requested action. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| If the module should wait for the instance action to be performed. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Pauses a compute instance - openstack.cloud.server_action: action: pause auth: auth_url: https://identity.example.com username: admin password: admin project_name: admin server: vm1 timeout: 200 ``` ### Authors * OpenStack Ansible SIG ansible openstack.cloud.identity_user – Manage OpenStack Identity Users openstack.cloud.identity\_user – Manage OpenStack Identity Users ================================================================ Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.identity_user`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage OpenStack Identity users. Users can be created, updated or deleted using this module. A user will be updated if name matches an existing user and state is present. The value for name cannot be updated without deleting and re-creating the user. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| default\_project string \| \| Project name or ID that the user should be associated with by default \| \| description string \| \| Description about the user \| \| domain string \| \| Domain to create the user in if the cloud supports domains \| \| email string \| \| Email address for the user \| \| enabled boolean \| Choices:* no * yes ← \| Is the user enabled \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| name string / required \| \| Username for the user \| \| password string \| \| Password for the user \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Should the resource be present or absent. \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| update\_password string \| Choices:* always * on\_create \| `always` will attempt to update password. `on_create` will only set the password for newly created users. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a user - openstack.cloud.identity_user: cloud: mycloud state: present name: demouser password: secret email: [email protected] domain: default default_project: demo # Delete a user - openstack.cloud.identity_user: cloud: mycloud state: absent name: demouser # Create a user but don't update password if user exists - openstack.cloud.identity_user: cloud: mycloud state: present name: demouser password: secret update_password: on_create email: [email protected] domain: default default_project: demo # Create a user without password - openstack.cloud.identity_user: cloud: mycloud state: present name: demouser email: [email protected] domain: default default_project: demo ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| user complex \| On success when state is 'present' \| Dictionary describing the user. \| \| \| default\_project\_id string \| success \| User default project ID. Only present with Keystone >= v3. Sample: 4427115787be45f08f0ec22a03bfc735 \| \| \| domain\_id string \| success \| User domain ID. Only present with Keystone >= v3. Sample: default \| \| \| email string \| success \| User email address Sample: [email protected] \| \| \| id string \| success \| User ID Sample: f59382db809c43139982ca4189404650 \| \| \| name string \| success \| User name Sample: demouser \| ### Authors * OpenStack Ansible SIG ansible openstack.cloud.router – Create or delete routers from OpenStack openstack.cloud.router – Create or delete routers from OpenStack ================================================================ Note This plugin is part of the [openstack.cloud collection](https://galaxy.ansible.com/openstack/cloud) (version 1.5.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install openstack.cloud`. To use it in a playbook, specify: `openstack.cloud.router`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create or Delete routers from OpenStack. Although Neutron allows routers to share the same name, this module enforces name uniqueness to be more user friendly. Requirements ------------ The below requirements are needed on the host that executes this module. * openstacksdk * openstacksdk >= 0.12.0 * python >= 3.6 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| admin\_state\_up boolean \| Choices:* no * yes ← \| Desired admin state of the created or existing router. \| \| api\_timeout integer \| \| How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. \| \| auth dictionary \| \| Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth\_url, username, password, project\_name and any information about domains (for example, user\_domain\_name or project\_domain\_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS\_\* environment variables are present. \| \| auth\_type string \| \| Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. \| \| availability\_zone string \| \| Ignored. Present for backwards compatibility \| \| ca\_cert string \| \| A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert \| \| client\_cert string \| \| A path to a client certificate to use as part of the SSL transaction. aliases: cert \| \| client\_key string \| \| A path to a client key to use as part of the SSL transaction. aliases: key \| \| cloud raw \| \| Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth\_type. This parameter is not needed if auth is provided or if OpenStack OS\_\* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. \| \| enable\_snat boolean \| Choices:* no * yes \| Enable Source NAT (SNAT) attribute. \| \| external\_fixed\_ips list / elements=dictionary \| \| The IP address parameters for the external gateway network. Each is a dictionary with the subnet name or ID (subnet) and the IP address to assign on the subnet (ip). If no IP is specified, one is automatically assigned from that subnet. \| \| \| ip string / required \| \| The fixed IP address to attempt to allocate. \| \| \| subnet string \| \| The subnet to attach the IP address to. \| \| interface string \| Choices:* admin * internal * public ← \| Endpoint URL type to fetch from the service catalog. aliases: endpoint\_type \| \| interfaces list / elements=raw \| \| List of subnets to attach to the router internal interface. Default gateway associated with the subnet will be automatically attached with the router's internal interface. In order to provide an ip address different from the default gateway,parameters are passed as dictionary with keys as network name or ID (net), subnet name or ID (subnet) and the IP of port (portip) from the network. User defined portip is often required when a multiple router need to be connected to a single subnet for which the default gateway has been already used. \| \| name string / required \| \| Name to be give to the router \| \| network string \| \| Unique name or ID of the external gateway network. required interfaces or enable\_snat are provided. \| \| project string \| \| Unique name or ID of the project. \| \| region\_name string \| \| Name of the region. \| \| state string \| Choices:* present ← * absent \| Indicate desired state of the resource \| \| timeout integer \| Default:180 \| How long should ansible wait for the requested resource. \| \| validate\_certs boolean \| Choices:* no * yes \| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify \| \| wait boolean \| Choices:* no * yes ← \| Should ansible wait until the requested resource is complete. \| Notes ----- Note * The standard OpenStack environment variables, such as `OS_USERNAME` may be used instead of providing explicit values. * Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at <https://docs.openstack.org/openstacksdk/> Examples -------- ``` # Create a simple router, not attached to a gateway or subnets. - openstack.cloud.router: cloud: mycloud state: present name: simple_router # Create a simple router, not attached to a gateway or subnets for a given project. - openstack.cloud.router: cloud: mycloud state: present name: simple_router project: myproj # Creates a router attached to ext_network1 on an IPv4 subnet and one # internal subnet interface. - openstack.cloud.router: cloud: mycloud state: present name: router1 network: ext_network1 external_fixed_ips: - subnet: public-subnet ip: 172.24.4.2 interfaces: - private-subnet # Create another router with two internal subnet interfaces.One with user defined port # ip and another with default gateway. - openstack.cloud.router: cloud: mycloud state: present name: router2 network: ext_network1 interfaces: - net: private-net subnet: private-subnet portip: 10.1.1.10 - project-subnet # Create another router with two internal subnet interface.One with user defined port # ip and and another with default gateway. - openstack.cloud.router: cloud: mycloud state: present name: router2 network: ext_network1 interfaces: - net: private-net subnet: private-subnet portip: 10.1.1.10 - project-subnet # Create another router with two internal subnet interface. one with user defined port # ip and and another with default gateway. - openstack.cloud.router: cloud: mycloud state: present name: router2 network: ext_network1 interfaces: - net: private-net subnet: private-subnet portip: 10.1.1.10 - project-subnet # Update existing router1 external gateway to include the IPv6 subnet. # Note that since 'interfaces' is not provided, any existing internal # interfaces on an existing router will be left intact. - openstack.cloud.router: cloud: mycloud state: present name: router1 network: ext_network1 external_fixed_ips: - subnet: public-subnet ip: 172.24.4.2 - subnet: ipv6-public-subnet ip: 2001:db8::3 # Delete router1 - openstack.cloud.router: cloud: mycloud state: absent name: router1 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| router complex \| On success when state is 'present' \| Dictionary describing the router. \| \| \| admin\_state\_up boolean \| success \| Administrative state of the router. Sample: True \| \| \| external\_gateway\_info dictionary \| success \| The external gateway parameters. Sample: {'enable\_snat': True, 'external\_fixed\_ips': [{'ip\_address': '10.6.6.99', 'subnet\_id': '4272cb52-a456-4c20-8f3c-c26024ecfa81'}]} \| \| \| id string \| success \| Router ID. Sample: 474acfe5-be34-494c-b339-50f06aa143e4 \| \| \| name string \| success \| Router name. Sample: router1 \| \| \| routes list / elements=string \| success \| The extra routes configuration for L3 router. \| \| \| status string \| success \| The router status. Sample: ACTIVE \| \| \| tenant\_id string \| success \| The tenant ID. Sample: 861174b82b43463c9edc5202aadc60ef \| ### Authors * OpenStack Ansible SIG	programming_docs
ansible Collections in the Netbox Namespace Collections in the Netbox Namespace =================================== These are the collections with docs hosted on [docs.ansible.com](https://docs.ansible.com/) in the netbox namespace. * [netbox.netbox](netbox/index#plugins-in-netbox-netbox) ansible netbox.netbox.netbox_route_target – Creates or removes route targets from Netbox netbox.netbox.netbox\_route\_target – Creates or removes route targets from Netbox ================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_route_target`. New in version 2.0.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes route targets from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the route target configuration \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| description string \| \| Tag description \| \| \| name string / required \| \| Route target name \| \| \| tags list / elements=raw \| \| Any tags that the device may need to be associated with \| \| \| tenant raw \| \| The tenant that the route target will be assigned to \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test route target creation/deletion" connection: local hosts: localhost gather_facts: False tasks: - name: Create Route Targets netbox.netbox.netbox_route_target: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "{{ item.name }}" tenant: "Test Tenant" tags: - Schnozzberry loop: - { name: "65000:65001", description: "management" } - { name: "65000:65002", description: "tunnel" } - name: Update Description on Route Targets netbox.netbox.netbox_route_target: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "{{ item.name }}" tenant: "Test Tenant" description: "{{ item.description }}" tags: - Schnozzberry loop: - { name: "65000:65001", description: "management" } - { name: "65000:65002", description: "tunnel" } - name: Delete Route Targets netbox.netbox.netbox_route_target: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "{{ item }}" state: absent loop: - "65000:65001" - "65000:65002" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| route\_target dictionary \| always \| Serialized object as created/existent/updated/deleted within Netbox \| ### Authors * Mikhail Yohman (@fragmentedpacket) ansible netbox.netbox.netbox_console_server_port_template – Create, update or delete console server port templates within Netbox netbox.netbox.netbox\_console\_server\_port\_template – Create, update or delete console server port templates within Netbox ============================================================================================================================ Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_console_server_port_template`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes console server port templates from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the console server port template configuration \| \| \| device\_type raw / required \| \| The device type the console server port template is attached to \| \| \| name string / required \| \| The name of the console server port template \| \| \| type string \| Choices:* de-9 * db-25 * rj-11 * rj-12 * rj-45 * usb-a * usb-b * usb-c * usb-mini-a * usb-mini-b * usb-micro-a * usb-micro-b * other \| The type of the console server port template \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create console server port template within Netbox with only required information netbox_console_server_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Server Port Template device_type: Test Device Type state: present - name: Update console server port template with other fields netbox_console_server_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Server Port Template device_type: Test Device Type type: iec-60320-c6 state: present - name: Delete console server port template within netbox netbox_console_server_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Server Port Template device_type: Test Device Type state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| console\_server\_port\_template dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_rack_role – Create, update or delete racks roles within Netbox netbox.netbox.netbox\_rack\_role – Create, update or delete racks roles within Netbox ===================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_rack_role`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes racks roles from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the rack role configuration \| \| \| color string \| \| Hexidecimal code for a color, ex. FFFFFF \| \| \| name string / required \| \| The name of the rack role \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create rack role within Netbox with only required information netbox_rack_role: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test rack role color: FFFFFF state: present - name: Delete rack role within netbox netbox_rack_role: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rack role state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| rack\_role dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_device_interface – Creates or removes interfaces on devices from Netbox netbox.netbox.netbox\_device\_interface – Creates or removes interfaces on devices from Netbox ============================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_device_interface`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes interfaces from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the interface configuration \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| description string \| \| The description of the interface \| \| \| device raw \| \| Name of the device the interface will be associated with (case-sensitive) \| \| \| enabled boolean \| Choices:* no * yes \| Sets whether interface shows enabled or disabled \| \| \| form\_factor raw \| \| Form factor of the interface: ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) This has to be specified exactly as what is found within UI \| \| \| label string \| \| Physical label of the interface \| \| \| lag raw \| \| Parent LAG interface will be a member of \| \| \| mac\_address string \| \| The MAC address of the interface \| \| \| mark\_connected boolean \| Choices:* no * yes \| Mark an interface as connected without a cable attached (netbox >= 2.11 required) \| \| \| mgmt\_only boolean \| Choices:* no * yes \| This interface is used only for out-of-band management \| \| \| mode raw \| \| The mode of the interface \| \| \| mtu integer \| \| The MTU of the interface \| \| \| name string / required \| \| Name of the interface to be created \| \| \| parent\_interface raw added in 3.2.0 of netbox.netbox \| \| The device's parent interface \| \| \| tagged\_vlans raw \| \| A list of tagged VLANS to be assigned to interface. Mode must be set to either `Tagged` or `Tagged All` \| \| \| tags list / elements=raw \| \| Any tags that the interface may need to be associated with \| \| \| type string \| \| Form factor of the interface: ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) This has to be specified exactly as what is found within UI \| \| \| untagged\_vlan raw \| \| The untagged VLAN to be assigned to interface \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| update\_vc\_child boolean \| Choices:* no ← * yes \| Use when master device is specified for `device` and the specified interface exists on a child device and needs updated \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox interface module" connection: local hosts: localhost gather_facts: False tasks: - name: Create interface within Netbox with only required information netbox_device_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: GigabitEthernet1 state: present - name: Delete interface within netbox netbox_device_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: GigabitEthernet1 state: absent - name: Create LAG with several specified options netbox_device_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: port-channel1 type: Link Aggregation Group (LAG) mtu: 1600 mgmt_only: false mode: Access state: present - name: Create interface and assign it to parent LAG netbox_device_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: GigabitEthernet1 enabled: false type: 1000Base-t (1GE) lag: name: port-channel1 mtu: 1600 mgmt_only: false mode: Access state: present - name: Create interface as a trunk port netbox_device_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: GigabitEthernet25 enabled: false type: 1000Base-t (1GE) untagged_vlan: name: Wireless site: Test Site tagged_vlans: - name: Data site: Test Site - name: VoIP site: Test Site mtu: 1600 mgmt_only: true mode: Tagged state: present - name: Update interface on child device on virtual chassis netbox_device_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: GigabitEthernet2/0/1 enabled: false update_vc_child: True - name: Mark interface as connected without a cable (netbox >= 2.11 required) netbox.netbox.netbox_device_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: GigabitEthernet1 mark_connected: true state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| interface dictionary \| on creation \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket)	programming_docs
ansible netbox.netbox.netbox_power_outlet – Create, update or delete power outlets within Netbox netbox.netbox.netbox\_power\_outlet – Create, update or delete power outlets within Netbox ========================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_power_outlet`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes power outlets from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the power outlet configuration \| \| \| description string \| \| Description of the power outlet \| \| \| device raw / required \| \| The device the power outlet is attached to \| \| \| feed\_leg string \| Choices:* A * B * C \| The phase, in case of three-phase feed \| \| \| name string / required \| \| The name of the power outlet \| \| \| power\_port raw \| \| The attached power port \| \| \| tags list / elements=raw \| \| Any tags that the power outlet may need to be associated with \| \| \| type string \| Choices:* iec-60320-c5 * iec-60320-c7 * iec-60320-c13 * iec-60320-c15 * iec-60320-c19 * iec-60309-p-n-e-4h * iec-60309-p-n-e-6h * iec-60309-p-n-e-9h * iec-60309-2p-e-4h * iec-60309-2p-e-6h * iec-60309-2p-e-9h * iec-60309-3p-e-4h * iec-60309-3p-e-6h * iec-60309-3p-e-9h * iec-60309-3p-n-e-4h * iec-60309-3p-n-e-6h * iec-60309-3p-n-e-9h * nema-5-15r * nema-5-20r * nema-5-30r * nema-5-50r * nema-6-15r * nema-6-20r * nema-6-30r * nema-6-50r * nema-l5-15r * nema-l5-20r * nema-l5-30r * nema-l5-50r * nema-l6-20r * nema-l6-30r * nema-l6-50r * nema-l14-20r * nema-l14-30r * nema-l21-20r * nema-l21-30r * CS6360C * CS6364C * CS8164C * CS8264C * CS8364C * CS8464C * ita-e * ita-f * ita-g * ita-h * ita-i * ita-j * ita-k * ita-l * ita-m * ita-n * ita-o * hdot-cx \| The type of the power outlet \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create power port within Netbox with only required information netbox_power_outlet: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet device: Test Device state: present - name: Update power port with other fields netbox_power_outlet: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet device: Test Device type: iec-60320-c6 power_port: Test Power Port feed_leg: A description: power port description state: present - name: Delete power port within netbox netbox_power_outlet: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet device: Test Device state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| power\_outlet dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_aggregate – Creates or removes aggregates from Netbox netbox.netbox.netbox\_aggregate – Creates or removes aggregates from Netbox =========================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_aggregate`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes aggregates from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the aggregate configuration \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| date\_added string \| \| Date added, format: YYYY-MM-DD \| \| \| description string \| \| The description of the aggregate \| \| \| prefix raw / required \| \| The aggregate prefix \| \| \| rir raw \| \| The RIR the aggregate will be assigned to \| \| \| tags list / elements=raw \| \| Any tags that the aggregate may need to be associated with \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* present ← * absent \| The state of the aggregate \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox aggregate module" connection: local hosts: localhost gather_facts: False tasks: - name: Create aggregate within Netbox with only required information netbox_aggregate: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 192.168.0.0/16 rir: Test RIR state: present - name: Create aggregate with several specified options netbox_aggregate: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 192.168.0.0/16 rir: Test RIR date_added: 1989-01-18 description: Test description tags: - Schnozzberry state: present - name: Delete aggregate within netbox netbox_aggregate: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 192.168.0.0/16 state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| aggregate dictionary \| on creation \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_site – Creates or removes sites from Netbox netbox.netbox.netbox\_site – Creates or removes sites from Netbox ================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_site`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes sites from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the site configuration \| \| \| asn integer \| \| The ASN associated with the site \| \| \| comments string \| \| Comments for the site. This can be markdown syntax \| \| \| contact\_email string \| \| Contact email for site \| \| \| contact\_name string \| \| Name of contact for site \| \| \| contact\_phone string \| \| Contact phone number for site \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| description string \| \| The description of the prefix \| \| \| facility string \| \| Data center provider or facility, ex. Equinix NY7 \| \| \| latitude string \| \| Latitude in decimal format \| \| \| longitude string \| \| Longitude in decimal format \| \| \| name string / required \| \| Name of the site to be created \| \| \| physical\_address string \| \| Physical address of site \| \| \| region raw \| \| The region that the site should be associated with \| \| \| shipping\_address string \| \| Shipping address of site \| \| \| site\_group raw added in 3.3.0 of netbox.netbox \| \| The site group the site will be associated with (NetBox 2.11+) \| \| \| slug string \| \| URL-friendly unique shorthand \| \| \| status raw \| \| Status of the site \| \| \| tags list / elements=raw \| \| Any tags that the prefix may need to be associated with \| \| \| tenant raw \| \| The tenant the site will be assigned to \| \| \| time\_zone string \| \| Timezone associated with the site, ex. America/Denver \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox site module" connection: local hosts: localhost gather_facts: False tasks: - name: Create site within Netbox with only required information netbox_site: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test - Colorado state: present - name: Delete site within netbox netbox_site: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test - Colorado state: absent - name: Create site with all parameters netbox_site: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test - California status: Planned region: Test Region site_group: Test Site Group tenant: Test Tenant facility: EquinoxCA7 asn: 65001 time_zone: America/Los Angeles description: This is a test description physical_address: Hollywood, CA, 90210 shipping_address: Hollywood, CA, 90210 latitude: 10.100000 longitude: 12.200000 contact_name: Jenny contact_phone: 867-5309 contact_email: [email protected] slug: test-california comments: ### Placeholder state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| site dictionary \| on creation \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible Netbox.Netbox Netbox.Netbox ============= Collection version 3.3.0 Plugin Index ------------ These are the plugins in the netbox.netbox collection ### Inventory Plugins * [nb\_inventory](nb_inventory_inventory#ansible-collections-netbox-netbox-nb-inventory-inventory) – NetBox inventory source ### Lookup Plugins * [nb\_lookup](nb_lookup_lookup#ansible-collections-netbox-netbox-nb-lookup-lookup) – Queries and returns elements from Netbox ### Modules * [netbox\_aggregate](netbox_aggregate_module#ansible-collections-netbox-netbox-netbox-aggregate-module) – Creates or removes aggregates from Netbox * [netbox\_cable](netbox_cable_module#ansible-collections-netbox-netbox-netbox-cable-module) – Create, update or delete cables within Netbox * [netbox\_circuit](netbox_circuit_module#ansible-collections-netbox-netbox-netbox-circuit-module) – Create, update or delete circuits within Netbox * [netbox\_circuit\_termination](netbox_circuit_termination_module#ansible-collections-netbox-netbox-netbox-circuit-termination-module) – Create, update or delete circuit terminations within Netbox * [netbox\_circuit\_type](netbox_circuit_type_module#ansible-collections-netbox-netbox-netbox-circuit-type-module) – Create, update or delete circuit types within Netbox * [netbox\_cluster](netbox_cluster_module#ansible-collections-netbox-netbox-netbox-cluster-module) – Create, update or delete clusters within Netbox * [netbox\_cluster\_group](netbox_cluster_group_module#ansible-collections-netbox-netbox-netbox-cluster-group-module) – Create, update or delete cluster groups within Netbox * [netbox\_cluster\_type](netbox_cluster_type_module#ansible-collections-netbox-netbox-netbox-cluster-type-module) – Create, update or delete cluster types within Netbox * [netbox\_config\_context](netbox_config_context_module#ansible-collections-netbox-netbox-netbox-config-context-module) – Creates, updates or deletes configuration contexts within Netbox * [netbox\_console\_port](netbox_console_port_module#ansible-collections-netbox-netbox-netbox-console-port-module) – Create, update or delete console ports within Netbox * [netbox\_console\_port\_template](netbox_console_port_template_module#ansible-collections-netbox-netbox-netbox-console-port-template-module) – Create, update or delete console port templates within Netbox * [netbox\_console\_server\_port](netbox_console_server_port_module#ansible-collections-netbox-netbox-netbox-console-server-port-module) – Create, update or delete console server ports within Netbox * [netbox\_console\_server\_port\_template](netbox_console_server_port_template_module#ansible-collections-netbox-netbox-netbox-console-server-port-template-module) – Create, update or delete console server port templates within Netbox * [netbox\_device](netbox_device_module#ansible-collections-netbox-netbox-netbox-device-module) – Create, update or delete devices within Netbox * [netbox\_device\_bay](netbox_device_bay_module#ansible-collections-netbox-netbox-netbox-device-bay-module) – Create, update or delete device bays within Netbox * [netbox\_device\_bay\_template](netbox_device_bay_template_module#ansible-collections-netbox-netbox-netbox-device-bay-template-module) – Create, update or delete device bay templates within Netbox * [netbox\_device\_interface](netbox_device_interface_module#ansible-collections-netbox-netbox-netbox-device-interface-module) – Creates or removes interfaces on devices from Netbox * [netbox\_device\_interface\_template](netbox_device_interface_template_module#ansible-collections-netbox-netbox-netbox-device-interface-template-module) – Creates or removes interfaces on devices from Netbox * [netbox\_device\_role](netbox_device_role_module#ansible-collections-netbox-netbox-netbox-device-role-module) – Create, update or delete devices roles within Netbox * [netbox\_device\_type](netbox_device_type_module#ansible-collections-netbox-netbox-netbox-device-type-module) – Create, update or delete device types within Netbox * [netbox\_front\_port](netbox_front_port_module#ansible-collections-netbox-netbox-netbox-front-port-module) – Create, update or delete front ports within Netbox * [netbox\_front\_port\_template](netbox_front_port_template_module#ansible-collections-netbox-netbox-netbox-front-port-template-module) – Create, update or delete front port templates within Netbox * [netbox\_inventory\_item](netbox_inventory_item_module#ansible-collections-netbox-netbox-netbox-inventory-item-module) – Creates or removes inventory items from Netbox * [netbox\_ip\_address](netbox_ip_address_module#ansible-collections-netbox-netbox-netbox-ip-address-module) – Creates or removes IP addresses from Netbox * [netbox\_ipam\_role](netbox_ipam_role_module#ansible-collections-netbox-netbox-netbox-ipam-role-module) – Creates or removes ipam roles from Netbox * [netbox\_location](netbox_location_module#ansible-collections-netbox-netbox-netbox-location-module) – Create, update or delete locations within NetBox * [netbox\_manufacturer](netbox_manufacturer_module#ansible-collections-netbox-netbox-netbox-manufacturer-module) – Create or delete manufacturers within Netbox * [netbox\_platform](netbox_platform_module#ansible-collections-netbox-netbox-netbox-platform-module) – Create or delete platforms within Netbox * [netbox\_power\_feed](netbox_power_feed_module#ansible-collections-netbox-netbox-netbox-power-feed-module) – Create, update or delete power feeds within Netbox * [netbox\_power\_outlet](netbox_power_outlet_module#ansible-collections-netbox-netbox-netbox-power-outlet-module) – Create, update or delete power outlets within Netbox * [netbox\_power\_outlet\_template](netbox_power_outlet_template_module#ansible-collections-netbox-netbox-netbox-power-outlet-template-module) – Create, update or delete power outlet templates within Netbox * [netbox\_power\_panel](netbox_power_panel_module#ansible-collections-netbox-netbox-netbox-power-panel-module) – Create, update or delete power panels within Netbox * [netbox\_power\_port](netbox_power_port_module#ansible-collections-netbox-netbox-netbox-power-port-module) – Create, update or delete power ports within Netbox * [netbox\_power\_port\_template](netbox_power_port_template_module#ansible-collections-netbox-netbox-netbox-power-port-template-module) – Create, update or delete power port templates within Netbox * [netbox\_prefix](netbox_prefix_module#ansible-collections-netbox-netbox-netbox-prefix-module) – Creates or removes prefixes from Netbox * [netbox\_provider](netbox_provider_module#ansible-collections-netbox-netbox-netbox-provider-module) – Create, update or delete providers within Netbox * [netbox\_rack](netbox_rack_module#ansible-collections-netbox-netbox-netbox-rack-module) – Create, update or delete racks within Netbox * [netbox\_rack\_group](netbox_rack_group_module#ansible-collections-netbox-netbox-netbox-rack-group-module) – Create, update or delete racks groups within Netbox * [netbox\_rack\_role](netbox_rack_role_module#ansible-collections-netbox-netbox-netbox-rack-role-module) – Create, update or delete racks roles within Netbox * [netbox\_rear\_port](netbox_rear_port_module#ansible-collections-netbox-netbox-netbox-rear-port-module) – Create, update or delete rear ports within Netbox * [netbox\_rear\_port\_template](netbox_rear_port_template_module#ansible-collections-netbox-netbox-netbox-rear-port-template-module) – Create, update or delete rear port templates within Netbox * [netbox\_region](netbox_region_module#ansible-collections-netbox-netbox-netbox-region-module) – Creates or removes regions from Netbox * [netbox\_rir](netbox_rir_module#ansible-collections-netbox-netbox-netbox-rir-module) – Create, update or delete RIRs within Netbox * [netbox\_route\_target](netbox_route_target_module#ansible-collections-netbox-netbox-netbox-route-target-module) – Creates or removes route targets from Netbox * [netbox\_service](netbox_service_module#ansible-collections-netbox-netbox-netbox-service-module) – Creates or removes service from Netbox * [netbox\_site](netbox_site_module#ansible-collections-netbox-netbox-netbox-site-module) – Creates or removes sites from Netbox * [netbox\_site\_group](netbox_site_group_module#ansible-collections-netbox-netbox-netbox-site-group-module) – Create, update, or delete site groups within NetBox * [netbox\_tag](netbox_tag_module#ansible-collections-netbox-netbox-netbox-tag-module) – Creates or removes tags from Netbox * [netbox\_tenant](netbox_tenant_module#ansible-collections-netbox-netbox-netbox-tenant-module) – Creates or removes tenants from Netbox * [netbox\_tenant\_group](netbox_tenant_group_module#ansible-collections-netbox-netbox-netbox-tenant-group-module) – Creates or removes tenant groups from Netbox * [netbox\_virtual\_chassis](netbox_virtual_chassis_module#ansible-collections-netbox-netbox-netbox-virtual-chassis-module) – Create, update or delete virtual chassis within Netbox * [netbox\_virtual\_machine](netbox_virtual_machine_module#ansible-collections-netbox-netbox-netbox-virtual-machine-module) – Create, update or delete virtual\_machines within Netbox * [netbox\_vlan](netbox_vlan_module#ansible-collections-netbox-netbox-netbox-vlan-module) – Create, update or delete vlans within Netbox * [netbox\_vlan\_group](netbox_vlan_group_module#ansible-collections-netbox-netbox-netbox-vlan-group-module) – Create, update or delete vlans groups within Netbox * [netbox\_vm\_interface](netbox_vm_interface_module#ansible-collections-netbox-netbox-netbox-vm-interface-module) – Creates or removes interfaces from virtual machines in Netbox * [netbox\_vrf](netbox_vrf_module#ansible-collections-netbox-netbox-netbox-vrf-module) – Create, update or delete vrfs within Netbox See also List of [collections](../../index#list-of-collections) with docs hosted here.	programming_docs
ansible netbox.netbox.netbox_vlan – Create, update or delete vlans within Netbox netbox.netbox.netbox\_vlan – Create, update or delete vlans within Netbox ========================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_vlan`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes vlans from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the vlan configuration \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| description string \| \| The description of the vlan \| \| \| name string / required \| \| The name of the vlan \| \| \| site raw \| \| The site the VLAN will be associated to \| \| \| status raw \| \| The status of the vlan \| \| \| tags list / elements=raw \| \| Any tags that the vlan may need to be associated with \| \| \| tenant raw \| \| The tenant that the vlan will be assigned to \| \| \| vid integer \| \| The VLAN ID \| \| \| vlan\_group raw \| \| The VLAN group the VLAN will be associated to \| \| \| vlan\_role raw \| \| Required if state=present and the vlan does not exist yet \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create vlan within Netbox with only required information netbox_vlan: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test VLAN vid: 400 state: present - name: Delete vlan within netbox netbox_vlan: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test VLAN vid: 400 state: absent - name: Create vlan with all information netbox_vlan: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test VLAN vid: 400 site: Test Site group: Test VLAN Group tenant: Test Tenant status: Deprecated vlan_role: Test VLAN Role description: Just a test tags: - Schnozzberry state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| vlan dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_front_port_template – Create, update or delete front port templates within Netbox netbox.netbox.netbox\_front\_port\_template – Create, update or delete front port templates within Netbox ========================================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_front_port_template`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes front port templates from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the front port template configuration \| \| \| device\_type raw / required \| \| The device type the front port template is attached to \| \| \| name string / required \| \| The name of the front port template \| \| \| rear\_port\_template raw / required \| \| The rear\_port\_template the front port template is attached to \| \| \| rear\_port\_template\_position integer \| \| The position of the rear port template this front port template is connected to \| \| \| type string \| Choices:* 8p8c * 110-punch * bnc * mrj21 * fc * lc * lc-apc * lsh * lsh-apc * mpo * mtrj * sc * sc-apc * st \| The type of the front port template \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create front port template within Netbox with only required information netbox_front_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Front Port Template device_type: Test Device Type type: bnc rear_port_template: Test Rear Port Template state: present - name: Update front port template with other fields netbox_front_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Front Port Template device_type: Test Device Type type: bnc rear_port_template: Test Rear Port Template rear_port_template_position: 5 state: present - name: Delete front port template within netbox netbox_front_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Front Port Template device_type: Test Device Type type: bnc rear_port_template: Test Rear Port Template state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| front\_port\_template dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_site_group – Create, update, or delete site groups within NetBox netbox.netbox.netbox\_site\_group – Create, update, or delete site groups within NetBox ======================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_site_group`. New in version 3.4.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates, or deletes site groups within NetBox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the site group configuration \| \| \| description string \| \| The description of the site group \| \| \| name string / required \| \| Name of the site group to be created \| \| \| parent\_site\_group raw \| \| The parent site group the site group will be associated with \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within NetBox to authorize API access \| \| netbox\_url string / required \| \| URL of the NetBox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test NetBox site group module" connection: local hosts: localhost gather_facts: False tasks: - name: Create site group within NetBox with only required information netbox.netbox.netbox_site_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Site group state: present - name: Create site group within NetBox with a parent site group netbox.netbox.netbox_site_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Child site group parent_site_group: Site group state: present - name: Delete site group within NetBox netbox.netbox.netbox_site_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Site group state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| site\_group dictionary \| success (when state=present) \| Serialized object as created or already existent within NetBox \| ### Authors * Andrew Simmons (@andybro19) ansible netbox.netbox.netbox_virtual_machine – Create, update or delete virtual_machines within Netbox netbox.netbox.netbox\_virtual\_machine – Create, update or delete virtual\_machines within Netbox ================================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_virtual_machine`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes virtual\_machines from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the virtual machine configuration \| \| \| cluster raw \| \| The name of the cluster attach to the virtual machine \| \| \| comments string \| \| Comments of the virtual machine \| \| \| custom\_fields dictionary \| \| Must exist in Netbox \| \| \| disk integer \| \| Disk of the virtual machine (GB) \| \| \| local\_context\_data dictionary \| \| configuration context of the virtual machine \| \| \| memory integer \| \| Memory of the virtual machine (MB) \| \| \| name string / required \| \| The name of the virtual machine \| \| \| platform raw \| \| The platform of the virtual machine \| \| \| primary\_ip4 raw \| \| Primary IPv4 address assigned to the virtual machine \| \| \| primary\_ip6 raw \| \| Primary IPv6 address assigned to the virtual machine \| \| \| site raw \| \| The name of the site attach to the virtual machine \| \| \| status raw \| \| The status of the virtual machine \| \| \| tags list / elements=raw \| \| Any tags that the virtual machine may need to be associated with \| \| \| tenant raw \| \| The tenant that the virtual machine will be assigned to \| \| \| vcpus float \| \| Number of vcpus of the virtual machine \| \| \| virtual\_machine\_role raw \| \| The role of the virtual machine \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create virtual machine within Netbox with only required information netbox_virtual_machine: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Virtual Machine cluster: test cluster state: present - name: Delete virtual machine within netbox netbox_virtual_machine: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Virtual Machine state: absent - name: Create virtual machine with tags netbox_virtual_machine: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Another Test Virtual Machine cluster: test cluster site: Test Site tags: - Schnozzberry state: present - name: Update vcpus, memory and disk of an existing virtual machine netbox_virtual_machine: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Virtual Machine cluster: test cluster vcpus: 8 memory: 8 disk: 8 state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| virtual machine dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Gaelle MANGIN (@gmangin) ansible netbox.netbox.netbox_device_interface_template – Creates or removes interfaces on devices from Netbox netbox.netbox.netbox\_device\_interface\_template – Creates or removes interfaces on devices from Netbox ======================================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_device_interface_template`. New in version 0.3.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes interfaces from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the prefix configuration \| \| \| device\_type raw / required \| \| Name of the device the interface template will be associated with (case-sensitive) \| \| \| mgmt\_only boolean \| Choices:* no * yes \| This interface template is used only for out-of-band management \| \| \| name string / required \| \| Name of the interface template to be created \| \| \| type string / required \| \| Form factor of the interface: ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) This has to be specified exactly as what is found within UI \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox interface template module" connection: local hosts: localhost gather_facts: False tasks: - name: Create interface template within Netbox with only required information netbox_device_interface_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device_type: Arista Test name: 10GBASE-T (10GE) type: 10gbase-t state: present - name: Delete interface template within netbox netbox_device_interface_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device_type: Arista Test name: 10GBASE-T (10GE) type: 10gbase-t state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| interface\_template dictionary \| on creation \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb)	programming_docs
ansible netbox.netbox.netbox_tenant_group – Creates or removes tenant groups from Netbox netbox.netbox.netbox\_tenant\_group – Creates or removes tenant groups from Netbox ================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_tenant_group`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes tenant groups from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the tenant group configuration \| \| \| description string \| \| The description of the tenant group \| \| \| name string / required \| \| Name of the tenant group to be created \| \| \| parent\_tenant\_group string \| \| Slug of the parent tenant group \| \| \| slug string \| \| URL-friendly unique shorthand \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox tenant group module" connection: local hosts: localhost gather_facts: False tasks: - name: Create tenant within Netbox with only required information netbox_tenant_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Tenant Group ABC slug: "tenant_group_abc" state: present - name: Delete tenant within netbox netbox_tenant_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Tenant ABC state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| tenant\_group dictionary \| on creation \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_region – Creates or removes regions from Netbox netbox.netbox.netbox\_region – Creates or removes regions from Netbox ===================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_region`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes regions from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the region configuration \| \| \| name string / required \| \| Name of the region to be created \| \| \| parent\_region raw \| \| The parent region this region should be tied to \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox region module" connection: local hosts: localhost gather_facts: False tasks: - name: Create region within Netbox with only required information netbox.netbox.netbox_region: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "Test Region One" state: present - name: Delete region within netbox netbox.netbox.netbox_region: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "Test Region One" state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| region dictionary \| on creation \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_console_port_template – Create, update or delete console port templates within Netbox netbox.netbox.netbox\_console\_port\_template – Create, update or delete console port templates within Netbox ============================================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_console_port_template`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes console port templates from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the console port template configuration \| \| \| device\_type raw / required \| \| The device type the console port template is attached to \| \| \| name string / required \| \| The name of the console port template \| \| \| type string \| Choices:* de-9 * db-25 * rj-11 * rj-12 * rj-45 * usb-a * usb-b * usb-c * usb-mini-a * usb-mini-b * usb-micro-a * usb-micro-b * other \| The type of the console port template \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create console port template within Netbox with only required information netbox_console_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Port Template device_type: Test Device Type state: present - name: Update console port template with other fields netbox_console_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Port Template device_type: Test Device Type type: iec-60320-c6 state: present - name: Delete console port template within netbox netbox_console_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Port Template device_type: Test Device Type state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| console\_port\_template dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_circuit_type – Create, update or delete circuit types within Netbox netbox.netbox.netbox\_circuit\_type – Create, update or delete circuit types within Netbox ========================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_circuit_type`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes circuit types from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the circuit type configuration \| \| \| name string / required \| \| The name of the circuit type \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create type within Netbox with only required information netbox_circuit_type: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Circuit Type state: present - name: Delete circuit type within netbox netbox_circuit_type: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Circuit Type state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| circuit\_type dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_rear_port_template – Create, update or delete rear port templates within Netbox netbox.netbox.netbox\_rear\_port\_template – Create, update or delete rear port templates within Netbox ======================================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_rear_port_template`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes rear port templates from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the rear port template configuration \| \| \| device\_type raw / required \| \| The device type the rear port template is attached to \| \| \| name string / required \| \| The name of the rear port template \| \| \| positions integer \| \| The number of front ports which may be mapped to each rear port \| \| \| type string \| Choices:* 8p8c * 110-punch * bnc * mrj21 * fc * lc * lc-apc * lsh * lsh-apc * mpo * mtrj * sc * sc-apc * st \| The type of the rear port \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create rear port template within Netbox with only required information netbox_rear_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port Template device_type: Test Device Type type: bnc state: present - name: Update rear port template with other fields netbox_rear_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port Template device_type: Test Device Type type: bnc positions: 5 state: present - name: Delete rear port template within netbox netbox_rear_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port Template device_type: Test Device Type type: bnc state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| rear\_port\_template dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_device_bay – Create, update or delete device bays within Netbox netbox.netbox.netbox\_device\_bay – Create, update or delete device bays within Netbox ====================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_device_bay`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes device bays from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the device bay configuration \| \| \| description string \| \| The description of the device bay. This is supported on v2.6+ of Netbox \| \| \| device raw \| \| The device the device bay will be associated to. The device type must be "parent". \| \| \| installed\_device raw \| \| The ddevice that will be installed into the bay. The device type must be "child". \| \| \| name string / required \| \| The name of the device bay \| \| \| tags list / elements=raw \| \| Any tags that the device bay may need to be associated with \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create device bay within Netbox with only required information netbox_device_bay: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: Test Nexus One name: "Device Bay One" state: present - name: Add device into device bay netbox_device_bay: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: Test Nexus One name: "Device Bay One" description: "First child" installed_device: Test Nexus Child One state: absent - name: Delete device bay within netbox netbox_device_bay: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Device Bay One state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| device\_bay dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket)	programming_docs
ansible netbox.netbox.netbox_vlan_group – Create, update or delete vlans groups within Netbox netbox.netbox.netbox\_vlan\_group – Create, update or delete vlans groups within Netbox ======================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_vlan_group`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes vlans groups from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the vlan group configuration \| \| \| custom\_fields dictionary added in 3.1.0 of netbox.netbox \| \| must exist in Netbox \| \| \| description string added in 3.1.0 of netbox.netbox \| \| Description for VLAN group \| \| \| name string / required \| \| The name of the vlan group \| \| \| scope raw added in 3.1.0 of netbox.netbox \| \| Object related to scope type (NetBox 2.11+) \| \| \| scope\_type string added in 3.1.0 of netbox.netbox \| Choices:* dcim.location * dcim.rack * dcim.region * dcim.site * dcim.sitegroup * virtualization.cluster * virtualization.clustergroup \| Type of scope to be applied (NetBox 2.11+) \| \| \| site raw \| \| The site the vlan will be assigned to (NetBox < 2.11) Will be removed in version 5.0.0 \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create vlan group within Netbox with only required information - Pre 2.11 netbox_vlan_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test vlan group site: Test Site state: present - name: Create vlan group within Netbox with only required information - Post 2.11 netbox_vlan_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test vlan group scope_type: "dcim.site" scope: Test Site state: present - name: Delete vlan group within netbox netbox_vlan_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test vlan group state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| vlan\_group dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_location – Create, update or delete locations within NetBox netbox.netbox.netbox\_location – Create, update or delete locations within NetBox ================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_location`. New in version 3.3.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes locations from NetBox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the location configuration \| \| \| description string \| \| The description of the location \| \| \| name string / required \| \| The name of the location \| \| \| parent\_location raw \| \| The parent location the location will be associated with \| \| \| site raw \| \| Required if state=present and the location does not exist yet \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within NetBox to authorize API access \| \| netbox\_url string / required \| \| URL of the NetBox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test NetBox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create location within NetBox with only required information netbox.netbox.netbox_location: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test location site: Test Site state: present - name: Create location within NetBox with a parent location netbox.netbox.netbox_location: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Child location site: Test Site parent_location: Test location state: present - name: Delete location within NetBox netbox.netbox.netbox_location: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test location state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| location dictionary \| success (when state=present) \| Serialized object as created or already existent within NetBox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Andrew Simmons (@andybro19) ansible netbox.netbox.netbox_platform – Create or delete platforms within Netbox netbox.netbox.netbox\_platform – Create or delete platforms within Netbox ========================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_platform`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes platforms from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the platform configuration \| \| \| description string \| \| The description of the platform \| \| \| manufacturer raw \| \| The manufacturer the platform will be tied to \| \| \| name string / required \| \| The name of the platform \| \| \| napalm\_args dictionary \| \| The optional arguments used for NAPALM connections \| \| \| napalm\_driver string \| \| The name of the NAPALM driver to be used when using the NAPALM plugin \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create platform within Netbox with only required information netbox_platform: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Platform state: present - name: Create platform within Netbox with only required information netbox_platform: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Platform All manufacturer: Test Manufacturer napalm_driver: ios napalm_args: global_delay_factor: 2 state: present - name: Delete platform within netbox netbox_platform: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Platform state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| platform dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_tenant – Creates or removes tenants from Netbox netbox.netbox.netbox\_tenant – Creates or removes tenants from Netbox ===================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_tenant`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes tenants from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the tenant configuration \| \| \| comments string \| \| Comments for the tenant. This can be markdown syntax \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| description string \| \| The description of the tenant \| \| \| name string / required \| \| Name of the tenant to be created \| \| \| slug string \| \| URL-friendly unique shorthand \| \| \| tags list / elements=raw \| \| Any tags that the tenant may need to be associated with \| \| \| tenant\_group raw \| \| Tenant group this tenant should be in \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox module" connection: local hosts: localhost gather_facts: False tasks: - name: Create tenant within Netbox with only required information netbox_tenant: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Tenant ABC state: present - name: Delete tenant within netbox netbox_tenant: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Tenant ABC state: absent - name: Create tenant with all parameters netbox_tenant: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Tenant ABC tenant_group: Very Special Tenants description: ABC Incorporated comments: '### This tenant is super cool' slug: tenant_abc tags: - tagA - tagB - tagC state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| tenant dictionary \| on creation \| Serialized object as created or already existent within Netbox \| ### Authors * Amy Liebowitz (@amylieb) ansible netbox.netbox.netbox_vm_interface – Creates or removes interfaces from virtual machines in Netbox netbox.netbox.netbox\_vm\_interface – Creates or removes interfaces from virtual machines in Netbox =================================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_vm_interface`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes interfaces from virtual machines in Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the vm interface configuration \| \| \| description string \| \| The description of the interface \| \| \| enabled boolean \| Choices:* no * yes \| Sets whether interface shows enabled or disabled \| \| \| mac\_address string \| \| The MAC address of the interface \| \| \| mode raw \| \| The mode of the interface \| \| \| mtu integer \| \| The MTU of the interface \| \| \| name string / required \| \| Name of the interface to be created \| \| \| parent\_vm\_interface raw added in 3.2.0 of netbox.netbox \| \| The virtual machine interface's parent interface. \| \| \| tagged\_vlans raw \| \| A list of tagged VLANS to be assigned to interface. Mode must be set to either `Tagged` or `Tagged All` \| \| \| tags list / elements=raw \| \| Any tags that the prefix may need to be associated with \| \| \| untagged\_vlan raw \| \| The untagged VLAN to be assigned to interface \| \| \| virtual\_machine raw \| \| Name of the virtual machine the interface will be associated with (case-sensitive) \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox interface module" connection: local hosts: localhost gather_facts: False tasks: - name: Create interface within Netbox with only required information netbox_vm_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: virtual_machine: test100 name: GigabitEthernet1 state: present - name: Delete interface within netbox netbox_vm_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: virtual_machine: test100 name: GigabitEthernet1 state: absent - name: Create interface as a trunk port netbox_vm_interface: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: virtual_machine: test100 name: GigabitEthernet25 enabled: false untagged_vlan: name: Wireless site: Test Site tagged_vlans: - name: Data site: Test Site - name: VoIP site: Test Site mtu: 1600 mode: Tagged state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| interface dictionary \| on creation \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Benjamin Vergnaud (@bvergnaud)	programming_docs
ansible netbox.netbox.netbox_inventory_item – Creates or removes inventory items from Netbox netbox.netbox.netbox\_inventory\_item – Creates or removes inventory items from Netbox ====================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_inventory_item`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes inventory items from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the inventory item configuration \| \| \| asset\_tag string \| \| The asset tag of the inventory item \| \| \| description string \| \| The description of the inventory item \| \| \| device raw \| \| Name of the device the inventory item belongs to \| \| \| discovered boolean \| Choices:* no ← * yes \| Set the discovery flag for the inventory item \| \| \| manufacturer raw \| \| The manufacturer of the inventory item \| \| \| name string / required \| \| Name of the inventory item to be created \| \| \| part\_id string \| \| The part ID of the inventory item \| \| \| serial string \| \| The serial number of the inventory item \| \| \| tags list / elements=raw \| \| Any tags that the device may need to be associated with \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox inventory_item module" connection: local hosts: localhost gather_facts: False tasks: - name: Create inventory item within Netbox with only required information netbox_inventory_item: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: "10G-SFP+" state: present - name: Update inventory item netbox_inventory_item: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: "10G-SFP+" manufacturer: "Cisco" part_id: "10G-SFP+" serial: "1234" asset_tag: "1234" description: "New SFP" state: present - name: Delete inventory item within netbox netbox_inventory_item: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: "10G-SFP+" state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| inventory\_item dictionary \| on creation \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_config_context – Creates, updates or deletes configuration contexts within Netbox netbox.netbox.netbox\_config\_context – Creates, updates or deletes configuration contexts within Netbox ======================================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_config_context`. New in version 3.3.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes configuration contexts from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the configuration context \| \| \| cluster\_groups list / elements=string \| \| List of cluster\_groups to which configuration context applies \| \| \| clusters list / elements=string \| \| List of clusters to which configuration context applies \| \| \| data dictionary \| \| JSON-formatted configuration context data \| \| \| description string \| \| The description of the configuration context \| \| \| device\_types list / elements=string \| \| List of device\_types to which configuration context applies \| \| \| is\_active boolean \| Choices:* no * yes \| Whether configuration context is active \| \| \| name string / required \| \| Name of the context \| \| \| platforms list / elements=string \| \| List of platforms to which configuration context applies \| \| \| regions list / elements=string \| \| List of regions where configuration context applies \| \| \| roles list / elements=string \| \| List of roles to which configuration context applies \| \| \| sites list / elements=string \| \| List of sites where configuration context applies \| \| \| tags list / elements=string \| \| Any tags that the configuration context associates with \| \| \| tenant\_groups list / elements=string \| \| List of tenant\_groups to which configuration context applies \| \| \| tenants list / elements=string \| \| List of tenants to which configuration context applies \| \| \| weight integer \| \| The weight of the configuration context \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox config_context module" connection: local hosts: localhost gather_facts: False tasks: - name: Create config context and apply it to sites euc1-az1, euc1-az2 with the default weight of 1000 netbox_config_context: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "dns_nameservers-quadnine" description: "9.9.9.9" data: "{ \"dns\": { \"nameservers\": [ \"9.9.9.9\" ] } }" sites: [ euc1-az1, euc1-az2 ] - name: Detach config context from euc1-az1, euc1-az2 and attach to euc1-az3 netbox_config_context: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "dns_nameservers-quadnine" data: "{ \"dns\": { \"nameservers\": [ \"9.9.9.9\" ] } }" sites: [ euc1-az3 ] - name: Delete config context netbox_config_context: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "dns_nameservers-quadnine" data: "{ \"dns\": { \"nameservers\": [ \"9.9.9.9\" ] } }" state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| config\_context dictionary \| always \| Serialized object as created/existent/updated/deleted within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Pavel Korovin (@pkorovin) ansible netbox.netbox.netbox_device_role – Create, update or delete devices roles within Netbox netbox.netbox.netbox\_device\_role – Create, update or delete devices roles within Netbox ========================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_device_role`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes devices roles from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the device role configuration \| \| \| color string \| \| Hexidecimal code for a color, ex. FFFFFF \| \| \| description string \| \| The description of the device role \| \| \| name string / required \| \| The name of the device role \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| \| vm\_role boolean \| Choices:* no * yes \| Whether the role is a VM role \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create device role within Netbox with only required information netbox_device_role: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test device role color: FFFFFF state: present - name: Delete device role within netbox netbox_device_role: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rack role state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| device\_role dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_rack_group – Create, update or delete racks groups within Netbox netbox.netbox.netbox\_rack\_group – Create, update or delete racks groups within Netbox ======================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_rack_group`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes racks groups from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the rack group configuration \| \| \| name string / required \| \| The name of the rack group \| \| \| site raw \| \| Required if state=present and the rack does not exist yet \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create rack group within Netbox with only required information netbox_rack_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test rack group site: Test Site state: present - name: Delete rack group within netbox netbox_rack_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rack group site: Test Site state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| rack\_group dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_cluster_type – Create, update or delete cluster types within Netbox netbox.netbox.netbox\_cluster\_type – Create, update or delete cluster types within Netbox ========================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_cluster_type`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes cluster types from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the cluster type configuration \| \| \| description string \| \| The description of the cluster type \| \| \| name string / required \| \| The name of the cluster type \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create cluster type within Netbox with only required information netbox_cluster_type: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Cluster Type state: present - name: Delete cluster within netbox netbox_cluster_type: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Cluster Type state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cluster\_type dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket)	programming_docs
ansible netbox.netbox.netbox_cluster – Create, update or delete clusters within Netbox netbox.netbox.netbox\_cluster – Create, update or delete clusters within Netbox =============================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_cluster`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes clusters from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the cluster configuration \| \| \| cluster\_group raw \| \| group of the cluster \| \| \| cluster\_type raw \| \| type of the cluster \| \| \| comments string \| \| Comments that may include additional information in regards to the cluster \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| name string / required \| \| The name of the cluster \| \| \| site raw \| \| Required if state=present and the cluster does not exist yet \| \| \| tags list / elements=raw \| \| Any tags that the cluster may need to be associated with \| \| \| tenant raw \| \| Tenant the cluster will be assigned to. \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create cluster within Netbox with only required information netbox_cluster: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Cluster cluster_type: libvirt state: present - name: Delete cluster within netbox netbox_cluster: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Cluster state: absent - name: Create cluster with tags netbox_cluster: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Another Test Cluster cluster_type: libvirt tags: - Schnozzberry state: present - name: Update the group and site of an existing cluster netbox_cluster: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Cluster cluster_type: qemu cluster_group: GROUP site: SITE state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cluster dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Gaelle MANGIN (@gmangin) ansible netbox.netbox.netbox_power_outlet_template – Create, update or delete power outlet templates within Netbox netbox.netbox.netbox\_power\_outlet\_template – Create, update or delete power outlet templates within Netbox ============================================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_power_outlet_template`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes power outlet templates from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the power outlet configuration \| \| \| device\_type raw / required \| \| The device type the power outlet is attached to \| \| \| feed\_leg string \| Choices:* A * B * C \| The phase, in case of three-phase feed \| \| \| name string / required \| \| The name of the power outlet \| \| \| power\_port\_template raw \| \| The attached power port template \| \| \| type string \| Choices:* iec-60320-c5 * iec-60320-c7 * iec-60320-c13 * iec-60320-c15 * iec-60320-c19 * iec-60309-p-n-e-4h * iec-60309-p-n-e-6h * iec-60309-p-n-e-9h * iec-60309-2p-e-4h * iec-60309-2p-e-6h * iec-60309-2p-e-9h * iec-60309-3p-e-4h * iec-60309-3p-e-6h * iec-60309-3p-e-9h * iec-60309-3p-n-e-4h * iec-60309-3p-n-e-6h * iec-60309-3p-n-e-9h * nema-5-15r * nema-5-20r * nema-5-30r * nema-5-50r * nema-6-15r * nema-6-20r * nema-6-30r * nema-6-50r * nema-l5-15r * nema-l5-20r * nema-l5-30r * nema-l5-50r * nema-l6-20r * nema-l6-30r * nema-l6-50r * nema-l14-20r * nema-l14-30r * nema-l21-20r * nema-l21-30r * CS6360C * CS6364C * CS8164C * CS8264C * CS8364C * CS8464C * ita-e * ita-f * ita-g * ita-h * ita-i * ita-j * ita-k * ita-l * ita-m * ita-n * ita-o * hdot-cx \| The type of the power outlet \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create power outlet template within Netbox with only required information netbox_power_outlet_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet Template device_type: Test Device Type state: present - name: Update power outlet template with other fields netbox_power_outlet_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet Template device_type: Test Device Type type: iec-60320-c6 power_port_template: Test Power Port Template feed_leg: A state: present - name: Delete power outlet template within netbox netbox_power_outlet_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Outlet Template device_type: Test Device Type state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| power\_outlet\_template dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.nb_inventory – NetBox inventory source netbox.netbox.nb\_inventory – NetBox inventory source ===================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.nb_inventory`. * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) Synopsis -------- * Get inventory hosts from NetBox Parameters ---------- \| Parameter \| Choices/Defaults \| Configuration \| Comments \| \| --- \| --- \| --- \| --- \| \| ansible\_host\_dns\_name boolean \| Choices:* no ← * yes \| \| If True, sets DNS Name (fetched from primary\_ip) to be used in ansible\_host variable, instead of IP Address. \| \| api\_endpoint string / required \| \| env:NETBOX\_API \| Endpoint of the NetBox API \| \| ca\_path string \| Default:"no" \| \| CA path \| \| cache boolean \| Choices:* no ← * yes \| ini entries: [inventory]cache = no env:ANSIBLE\_INVENTORY\_CACHE \| Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work. \| \| cache\_connection string \| \| ini entries: [defaults]fact\_caching\_connection = None [inventory]cache\_connection = None env:ANSIBLE\_CACHE\_PLUGIN\_CONNECTION env:ANSIBLE\_INVENTORY\_CACHE\_CONNECTION \| Cache connection data or path, read cache plugin documentation for specifics. \| \| cache\_plugin string \| Default:"memory" \| ini entries: [defaults]fact\_caching = memory [inventory]cache\_plugin = memory env:ANSIBLE\_CACHE\_PLUGIN env:ANSIBLE\_INVENTORY\_CACHE\_PLUGIN \| Cache plugin to use for the inventory's source data. \| \| cache\_prefix string \| Default:"ansible\_inventory\_" \| ini entries: [default]fact\_caching\_prefix = ansible\_inventory\_ [inventory]cache\_prefix = ansible\_inventory\_ env:ANSIBLE\_CACHE\_PLUGIN\_PREFIX env:ANSIBLE\_INVENTORY\_CACHE\_PLUGIN\_PREFIX \| Prefix to use for cache plugin files/tables \| \| cache\_timeout integer \| Default:3600 \| ini entries: [defaults]fact\_caching\_timeout = 3600 [inventory]cache\_timeout = 3600 env:ANSIBLE\_CACHE\_PLUGIN\_TIMEOUT env:ANSIBLE\_INVENTORY\_CACHE\_TIMEOUT \| Cache duration in seconds \| \| cert string \| Default:"no" \| \| Certificate path \| \| compose dictionary \| Default:{} \| \| List of custom ansible host vars to create from the device object fetched from NetBox \| \| config\_context boolean \| Choices:* no ← * yes \| \| If True, it adds config\_context in host vars. Config-context enables the association of arbitrary data to devices and virtual machines grouped by region, site, role, platform, and/or tenant. Please check official netbox docs for more info. \| \| device\_query\_filters list / elements=string \| Default:[] \| \| List of parameters passed to the query string for devices (Multiple values may be separated by commas) \| \| dns\_name boolean \| Choices:* no ← * yes \| \| Force IP Addresses to be fetched so that the dns\_name for the primary\_ip of each device or VM is set as a host\_var. Setting interfaces will also fetch IP addresses and the dns\_name host\_var will be set. \| \| fetch\_all boolean added in 0.2.1 of netbox.netbox \| Choices:* no * yes ← \| \| By default, fetching interfaces and services will get all of the contents of NetBox regardless of query\_filters applied to devices and VMs. When set to False, separate requests will be made fetching interfaces, services, and IP addresses for each device\_id and virtual\_machine\_id. If you are using the various query\_filters options to reduce the number of devices, you may find querying Netbox faster with fetch\_all set to False. For efficiency, when False, these requests will be batched, for example /api/dcim/interfaces?limit=0&device\_id=1&device\_id=2&device\_id=3 These GET request URIs can become quite large for a large number of devices. If you run into HTTP 414 errors, you can adjust the max\_uri\_length option to suit your web server. \| \| flatten\_config\_context boolean added in 0.2.1 of netbox.netbox \| Choices:* no ← * yes \| \| If config\_context is enabled, by default it's added as a host var named config\_context. If flatten\_config\_context is set to True, the config context variables will be added directly to the host instead. \| \| flatten\_custom\_fields boolean added in 0.2.1 of netbox.netbox \| Choices:* no ← * yes \| \| By default, host custom fields are added as a dictionary host var named custom\_fields. If flatten\_custom\_fields is set to True, the fields will be added directly to the host instead. \| \| flatten\_local\_context\_data boolean added in 0.3.0 of netbox.netbox \| Choices:* no ← * yes \| \| If local\_context\_data is enabled, by default it's added as a host var named local\_context\_data. If flatten\_local\_context\_data is set to True, the config context variables will be added directly to the host instead. \| \| follow\_redirects string \| Choices:* urllib2 ← * all * yes * safe * none \| \| Determine how redirects are followed. By default, follow\_redirects is set to uses urllib2 default behavior. \| \| group\_by list / elements=string \| Choices:* sites * site * location * tenants * tenant * racks * rack * rack\_group * rack\_role * tags * tag * device\_roles * role * device\_types * device\_type * manufacturers * manufacturer * platforms * platform * region * cluster * cluster\_type * cluster\_group * is\_virtual * services * status Default:[] \| \| Keys used to create groups. The plurals option controls which of these are valid. rack\_group is supported on NetBox versions 2.10 or lower only location is supported on NetBox versions 2.11 or higher only \| \| group\_names\_raw boolean added in 0.2.0 of netbox.netbox \| Choices:* no ← * yes \| \| Will not add the group\_by choice name to the group names \| \| groups dictionary \| Default:{} \| \| Add hosts to group based on Jinja2 conditionals. \| \| interfaces boolean added in 0.1.7 of netbox.netbox \| Choices:* no ← * yes \| \| If True, it adds the device or virtual machine interface information in host vars. \| \| key string \| Default:"no" \| \| Certificate key path \| \| keyed\_groups list / elements=string \| Default:[] \| \| Add hosts to group based on the values of a variable. \| \| leading\_separator boolean added in 2.11 of ansible.builtin \| Choices:* no * yes ← \| \| Use in conjunction with keyed\_groups. By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. This is because the default prefix is "" and the default separator is "\_". Set this option to False to omit the leading underscore (or other separator) if no prefix is given. If the group name is derived from a mapping the separator is still used to concatenate the items. To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. \| \| max\_uri\_length integer added in 0.2.1 of netbox.netbox \| Default:4000 \| \| When fetch\_all is False, GET requests to NetBox may become quite long and return a HTTP 414 (URI Too Long). You can adjust this option to be smaller to avoid 414 errors, or larger for a reduced number of requests. \| \| plugin string / required \| Choices:* netbox.netbox.nb\_inventory \| \| token that ensures this is a source file for the 'netbox' plugin. \| \| plurals boolean added in 0.2.1 of netbox.netbox \| Choices:* no * yes ← \| \| If True, all host vars are contained inside single-element arrays for legacy compatibility with old versions of this plugin. Group names will be plural (ie. "sites\_mysite" instead of "site\_mysite") The choices of group\_by will be changed by this option. \| \| query\_filters list / elements=string \| Default:[] \| \| List of parameters passed to the query string for both devices and VMs (Multiple values may be separated by commas) \| \| services boolean added in 0.2.0 of netbox.netbox \| Choices:* no * yes ← \| \| If True, it adds the device or virtual machine services information in host vars. \| \| strict boolean \| Choices:* no ← * yes \| \| If `yes` make invalid entries a fatal error, otherwise skip and continue. Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. \| \| timeout integer \| Default:60 \| \| Timeout for Netbox requests in seconds \| \| token string \| \| env:NETBOX\_TOKEN env:NETBOX\_API\_KEY \| NetBox API token to be able to read against NetBox. This may not be required depending on the NetBox setup. \| \| use\_extra\_vars boolean added in 2.11 of ansible.builtin \| Choices:* no ← * yes \| ini entries: [inventory\_plugins]use\_extra\_vars = no env:ANSIBLE\_INVENTORY\_USE\_EXTRA\_VARS \| Merge extra vars into the available variables for composition (highest precedence). \| \| validate\_certs boolean \| Choices:* no * yes ← \| \| Allows connection when SSL certificates are not valid. Set to `false` when certificates are not trusted. \| \| virtual\_chassis\_name boolean \| Choices:* no ← * yes \| \| When a device is part of a virtual chassis, use the virtual chassis name as the Ansible inventory hostname. The host var values will be from the virtual chassis master. \| \| vm\_query\_filters list / elements=string \| Default:[] \| \| List of parameters passed to the query string for VMs (Multiple values may be separated by commas) \| Examples -------- ``` # netbox_inventory.yml file in YAML format # Example command line: ansible-inventory -v --list -i netbox_inventory.yml plugin: netbox.netbox.nb_inventory api_endpoint: http://localhost:8000 validate_certs: True config_context: False group_by: - device_roles query_filters: - role: network-edge-router device_query_filters: - has_primary_ip: 'true' # has_primary_ip is a useful way to filter out patch panels and other passive devices # Query filters are passed directly as an argument to the fetching queries. # You can repeat tags in the query string. query_filters: - role: server - tag: web - tag: production # See the NetBox documentation at https://netbox.readthedocs.io/en/stable/rest-api/overview/ # the query_filters work as a logical OR # # Prefix any custom fields with cf_ and pass the field value with the regular NetBox query string query_filters: - cf_foo: bar # NetBox inventory plugin also supports Constructable semantics # You can fill your hosts vars using the compose option: plugin: netbox.netbox.nb_inventory compose: foo: last_updated bar: display_name nested_variable: rack.display_name # You can use keyed_groups to group on properties of devices or VMs. # NOTE: It's only possible to key off direct items on the device/VM objects. plugin: netbox.netbox.nb_inventory keyed_groups: - prefix: status key: status.value ``` ### Authors * Remy Leone (@sieben) * Anthony Ruhier (@Anthony25) * Nikhil Singh Baliyan (@nikkytub) * Sander Steffann (@steffann) * Douglas Heriot (@DouglasHeriot)	programming_docs
ansible netbox.netbox.netbox_power_panel – Create, update or delete power panels within Netbox netbox.netbox.netbox\_power\_panel – Create, update or delete power panels within Netbox ======================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_power_panel`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes power panels from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the power panel configuration \| \| \| location raw added in 3.1.0 of netbox.netbox \| \| The location the power panel is assigned to (NetBox 2.11+) \| \| \| name string / required \| \| The name of the power panel \| \| \| rack\_group raw \| \| The rack group the power panel is assigned to (NetBox < 2.11) Will be removed in version 5.0.0 \| \| \| site raw / required \| \| The site the power panel is located in \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create power panel within Netbox with only required information netbox_power_panel: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Panel site: Test Site state: present - name: Update power panel with other fields - Pre 2.11 netbox_power_panel: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Panel site: Test Site rack_group: Test Rack Group state: present - name: Create power panel within Netbox with only required information - Post 2.11 netbox_power_panel: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Panel site: Test Site location: Test Location state: present - name: Delete power panel within netbox netbox_power_panel: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Panel site: Test Site state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| power\_panel dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_circuit – Create, update or delete circuits within Netbox netbox.netbox.netbox\_circuit – Create, update or delete circuits within Netbox =============================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_circuit`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes circuits from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the circuit configuration \| \| \| cid string / required \| \| The circuit id of the circuit \| \| \| circuit\_type raw \| \| The circuit type of the circuit \| \| \| comments string \| \| Comments related to circuit \| \| \| commit\_rate integer \| \| Commit rate of the circuit (Kbps) \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| description string \| \| Description of the circuit \| \| \| install\_date string \| \| The date the circuit was installed. e.g. YYYY-MM-DD \| \| \| provider raw \| \| The provider of the circuit \| \| \| status raw \| \| The status of the circuit \| \| \| tags list / elements=raw \| \| Any tags that the device may need to be associated with \| \| \| tenant raw \| \| The tenant assigned to the circuit \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create circuit within Netbox with only required information netbox_circuit: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: cid: Test Circuit provider: Test Provider circuit_type: Test Circuit Type state: present - name: Update circuit with other fields netbox_circuit: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: cid: Test-Circuit-1000 provider: Test Provider circuit_type: Test Circuit Type status: Active tenant: Test Tenant install_date: "2018-12-25" commit_rate: 10000 description: Test circuit comments: "FAST CIRCUIT" state: present - name: Delete circuit within netbox netbox_circuit: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: cid: Test-Circuit-1000 state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| circuit dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_cable – Create, update or delete cables within Netbox netbox.netbox.netbox\_cable – Create, update or delete cables within Netbox =========================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_cable`. New in version 0.3.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes cables from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the cable configuration \| \| \| color string \| \| The color of the cable \| \| \| label string \| \| The label of the cable \| \| \| length integer \| \| The length of the cable \| \| \| length\_unit string \| Choices:* m * cm * ft * in \| The unit in which the length of the cable is measured \| \| \| status string \| Choices:* connected * planned * decommissioning \| The status of the cable \| \| \| tags list / elements=raw \| \| Any tags that the cable may need to be associated with \| \| \| termination\_a raw / required \| \| The termination a \| \| \| termination\_a\_type string / required \| Choices:* circuits.circuittermination * dcim.consoleport * dcim.consoleserverport * dcim.frontport * dcim.interface * dcim.powerfeed * dcim.poweroutlet * dcim.powerport * dcim.rearport \| The type of the termination a \| \| \| termination\_b raw / required \| \| The termination b \| \| \| termination\_b\_type string / required \| Choices:* circuits.circuittermination * dcim.consoleport * dcim.consoleserverport * dcim.frontport * dcim.interface * dcim.powerfeed * dcim.poweroutlet * dcim.powerport * dcim.rearport \| The type of the termination b \| \| \| type string \| Choices:* cat3 * cat5 * cat5e * cat6 * cat6a * cat7 * dac-active * dac-passive * mrj21-trunk * coaxial * mmf * mmf-om1 * mmf-om2 * mmf-om3 * mmf-om4 * smf * smf-os1 * smf-os2 * aoc * power \| The type of the cable \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create cable within Netbox with only required information netbox_cable: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: termination_a_type: dcim.interface termination_a: device: Test Nexus Child One name: Ethernet2/2 termination_b_type: dcim.interface termination_b: device: Test Nexus Child One name: Ethernet2/1 state: present - name: Update cable with other fields netbox_cable: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: termination_a_type: dcim.interface termination_a: device: Test Nexus Child One name: Ethernet2/2 termination_b_type: dcim.interface termination_b: device: Test Nexus Child One name: Ethernet2/1 type: mmf-om4 status: planned label: label123 color: abcdef length: 30 length_unit: m tags: - foo state: present - name: Delete cable within netbox netbox_cable: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: termination_a_type: dcim.interface termination_a: device: Test Nexus Child One name: Ethernet2/2 termination_b_type: dcim.interface termination_b: device: Test Nexus Child One name: Ethernet2/1 state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cable dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_circuit_termination – Create, update or delete circuit terminations within Netbox netbox.netbox.netbox\_circuit\_termination – Create, update or delete circuit terminations within Netbox ======================================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_circuit_termination`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes circuit terminations from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the circuit termination configuration \| \| \| circuit raw / required \| \| The circuit to assign to circuit termination \| \| \| description string \| \| Description of the circuit termination \| \| \| port\_speed integer \| \| The speed of the port (Kbps) \| \| \| pp\_info string \| \| Patch panel information \| \| \| site raw \| \| The site the circuit termination will be assigned to \| \| \| term\_side string / required \| Choices:* A * Z \| The side of the circuit termination \| \| \| upstream\_speed integer \| \| The upstream speed of the circuit termination \| \| \| xconnect\_id string \| \| The cross connect ID of the circuit termination \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create circuit termination within Netbox with only required information netbox_circuit_termination: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: circuit: Test Circuit term_side: A site: Test Site port_speed: 10000 state: present - name: Update circuit termination with other fields netbox_circuit_termination: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: circuit: Test Circuit term_side: A upstream_speed: 1000 xconnect_id: 10X100 pp_info: PP10-24 description: "Test description" state: present - name: Delete circuit termination within netbox netbox_circuit_termination: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: circuit: Test Circuit term_side: A state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| circuit\_termination dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_cluster_group – Create, update or delete cluster groups within Netbox netbox.netbox.netbox\_cluster\_group – Create, update or delete cluster groups within Netbox ============================================================================================ Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_cluster_group`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes cluster groups from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the cluster group configuration \| \| \| name string / required \| \| The name of the cluster group \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create cluster group within Netbox with only required information netbox_cluster_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Cluster Group state: present - name: Delete cluster within netbox netbox_cluster_group: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Cluster Group state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cluster\_group dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket)	programming_docs
ansible netbox.netbox.netbox_device_type – Create, update or delete device types within Netbox netbox.netbox.netbox\_device\_type – Create, update or delete device types within Netbox ======================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_device_type`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes device types from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the device type configuration \| \| \| comments string \| \| Comments that may include additional information in regards to the device\_type \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| is\_full\_depth boolean \| Choices:* no * yes \| Whether or not the device consumes both front and rear rack faces \| \| \| manufacturer raw \| \| The manufacturer of the device type \| \| \| model raw / required \| \| The model of the device type \| \| \| part\_number string \| \| The part number of the device type \| \| \| slug string \| \| The slug of the device type. Must follow slug formatting (URL friendly) If not specified, it will slugify the model ex. test-device-type \| \| \| subdevice\_role string \| Choices:* Parent * parent * Child * child \| Whether the device type is parent, child, or neither \| \| \| tags list / elements=raw \| \| Any tags that the device type may need to be associated with \| \| \| u\_height integer \| \| The height of the device type in rack units \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create device type within Netbox with only required information netbox_device_type: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: slug: test-device-type model: ws-test-3750 manufacturer: Test Manufacturer state: present - name: Create device type within Netbox with only required information netbox_device_type: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: slug: test-device-type model: ws-test-3750 manufacturer: Test Manufacturer part_number: ws-3750g-v2 u_height: 1 is_full_depth: False subdevice_role: parent state: present - name: Delete device type within netbox netbox_device_type: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: slug: test-device-type state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| device\_type dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_virtual_chassis – Create, update or delete virtual chassis within Netbox netbox.netbox.netbox\_virtual\_chassis – Create, update or delete virtual chassis within Netbox =============================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_virtual_chassis`. New in version 0.3.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes virtual chassis from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the virtual chassis configuration \| \| \| domain string \| \| domain of the virtual chassis \| \| \| master raw \| \| The master device the virtual chassis is attached to \| \| \| name string \| \| Name \| \| \| tags list / elements=raw \| \| Any tags that the virtual chassis may need to be associated with \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create virtual chassis within Netbox with only required information netbox_virtual_chassis: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "Virtual Chassis 1" master: Test Device state: present - name: Update virtual chassis with other fields netbox_virtual_chassis: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: master: Test Device domain: Domain Text state: present - name: Delete virtual chassis within netbox netbox_virtual_chassis: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: master: Test Device state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| virtual\_chassis dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_power_port_template – Create, update or delete power port templates within Netbox netbox.netbox.netbox\_power\_port\_template – Create, update or delete power port templates within Netbox ========================================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_power_port_template`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes power port templates from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the power port configuration \| \| \| allocated\_draw integer \| \| The allocated draw of the power port in watt \| \| \| device\_type raw / required \| \| The device type the power port is attached to \| \| \| maximum\_draw integer \| \| The maximum permissible draw of the power port in watt \| \| \| name string / required \| \| The name of the power port \| \| \| type string \| Choices:* iec-60320-c6 * iec-60320-c8 * iec-60320-c14 * iec-60320-c16 * iec-60320-c20 * iec-60309-p-n-e-4h * iec-60309-p-n-e-6h * iec-60309-p-n-e-9h * iec-60309-2p-e-4h * iec-60309-2p-e-6h * iec-60309-2p-e-9h * iec-60309-3p-e-4h * iec-60309-3p-e-6h * iec-60309-3p-e-9h * iec-60309-3p-n-e-4h * iec-60309-3p-n-e-6h * iec-60309-3p-n-e-9h * nema-5-15p * nema-5-20p * nema-5-30p * nema-5-50p * nema-6-15p * nema-6-20p * nema-6-30p * nema-6-50p * nema-l5-15p * nema-l5-20p * nema-l5-30p * nema-l5-50p * nema-l6-20p * nema-l6-30p * nema-l6-50p * nema-l14-20p * nema-l14-30p * nema-l21-20p * nema-l21-30p * cs6361c * cs6365c * cs8165c * cs8265c * cs8365c * cs8465c * ita-e * ita-f * ita-ef * ita-g * ita-h * ita-i * ita-j * ita-k * ita-l * ita-m * ita-n * ita-o \| The type of the power port \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create power port within Netbox with only required information netbox_power_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port Template device_type: Test Device Type state: present - name: Update power port with other fields netbox_power_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port Template device_type: Test Device Type type: iec-60320-c6 allocated_draw: 16 maximum_draw: 80 state: present - name: Delete power port within netbox netbox_power_port_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port Template device_type: Test Device Type state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| power\_port\_template dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_console_server_port – Create, update or delete console server ports within Netbox netbox.netbox.netbox\_console\_server\_port – Create, update or delete console server ports within Netbox ========================================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_console_server_port`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes console server ports from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the console server port configuration \| \| \| description string \| \| Description of the console server port \| \| \| device raw / required \| \| The device the console server port is attached to \| \| \| name string / required \| \| The name of the console server port \| \| \| tags list / elements=raw \| \| Any tags that the console server port may need to be associated with \| \| \| type string \| Choices:* de-9 * db-25 * rj-11 * rj-12 * rj-45 * usb-a * usb-b * usb-c * usb-mini-a * usb-mini-b * usb-micro-a * usb-micro-b * other \| The type of the console server port \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create console server port within Netbox with only required information netbox_console_server_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Server Port device: Test Device state: present - name: Update console server port with other fields netbox_console_server_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Server Port device: Test Device type: usb-a description: console server port description state: present - name: Delete console server port within netbox netbox_console_server_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Server Port device: Test Device state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| console\_server\_port dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_ip_address – Creates or removes IP addresses from Netbox netbox.netbox.netbox\_ip\_address – Creates or removes IP addresses from Netbox =============================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_ip_address`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes IP addresses from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the IP address configuration \| \| \| address string \| \| Required if state is `present` \| \| \| assigned\_object dictionary \| \| Definition of the assigned object. \| \| \| \| device string \| \| The device the interface is attached to. \| \| \| \| name string \| \| The name of the interface \| \| \| \| virtual\_machine string \| \| The virtual machine the interface is attached to. \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| description string \| \| The description of the interface \| \| \| dns\_name string \| \| Hostname or FQDN \| \| \| family integer \| Choices:* 4 * 6 \| (DEPRECATED) - NetBox now handles determining the IP family natively. Specifies with address family the IP address belongs to \| \| \| interface raw \| \| The name and device of the interface that the IP address should be assigned to Required if state is `present` and a prefix specified. \| \| \| nat\_inside raw \| \| The inside IP address this IP is assigned to \| \| \| prefix raw \| \| With state `present`, if an interface is given, it will ensure that an IP inside this prefix (and vrf, if given) is attached to this interface. Otherwise, it will get the next available IP of this prefix and attach it. With state `new`, it will force to get the next available IP in this prefix. If an interface is given, it will also force to attach it. Required if state is `present` or `new` when no address is given. Unused if an address is specified. \| \| \| role string \| Choices:* Loopback * Secondary * Anycast * VIP * VRRP * HSRP * GLBP * CARP \| The role of the IP address \| \| \| status raw \| \| The status of the IP address \| \| \| tags list / elements=raw \| \| Any tags that the IP address may need to be associated with \| \| \| tenant raw \| \| The tenant that the device will be assigned to \| \| \| vrf raw \| \| VRF that IP address is associated with \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * new * present ← \| Use `present`, `new` or `absent` for adding, force adding or removing. `present` will check if the IP is already created, and return it if true. `new` will force to create it anyway (useful for anycasts, for example). \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox IP address module" connection: local hosts: localhost gather_facts: False tasks: - name: Create IP address within Netbox with only required information netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: address: 192.168.1.10 state: present - name: Force to create (even if it already exists) the IP netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: address: 192.168.1.10 state: new - name: Get a new available IP inside 192.168.1.0/24 netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 192.168.1.0/24 state: new - name: Delete IP address within netbox netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: address: 192.168.1.10 state: absent - name: Create IP address with several specified options netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: address: 192.168.1.20 vrf: Test tenant: Test Tenant status: Reserved role: Loopback description: Test description tags: - Schnozzberry state: present - name: Create IP address and assign a nat_inside IP netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: address: 192.168.1.30 vrf: Test nat_inside: address: 192.168.1.20 vrf: Test interface: name: GigabitEthernet1 device: test100 - name: Ensure that an IP inside 192.168.1.0/24 is attached to GigabitEthernet1 netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 192.168.1.0/24 vrf: Test interface: name: GigabitEthernet1 device: test100 state: present - name: Attach a new available IP of 192.168.1.0/24 to GigabitEthernet1 netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 192.168.1.0/24 vrf: Test interface: name: GigabitEthernet1 device: test100 state: new - name: Attach a new available IP of 192.168.1.0/24 to GigabitEthernet1 (NetBox 2.9+) netbox_ip_address: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 192.168.1.0/24 vrf: Test assigned_object: name: GigabitEthernet1 device: test100 state: new ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| ip\_address dictionary \| on creation \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) * Anthony Ruhier (@Anthony25)	programming_docs
ansible netbox.netbox.netbox_console_port – Create, update or delete console ports within Netbox netbox.netbox.netbox\_console\_port – Create, update or delete console ports within Netbox ========================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_console_port`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes console ports from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the console port configuration \| \| \| description string \| \| Description of the console port \| \| \| device raw / required \| \| The device the console port is attached to \| \| \| name string / required \| \| The name of the console port \| \| \| tags list / elements=raw \| \| Any tags that the console port may need to be associated with \| \| \| type string \| Choices:* de-9 * db-25 * rj-11 * rj-12 * rj-45 * usb-a * usb-b * usb-c * usb-mini-a * usb-mini-b * usb-micro-a * usb-micro-b * other \| The type of the console port \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create console port within Netbox with only required information netbox_console_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Port device: Test Device state: present - name: Update console port with other fields netbox_console_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Port device: Test Device type: usb-a description: console port description state: present - name: Delete console port within netbox netbox_console_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Console Port device: Test Device state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| console\_port dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_prefix – Creates or removes prefixes from Netbox netbox.netbox.netbox\_prefix – Creates or removes prefixes from Netbox ====================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_prefix`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes prefixes from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the prefix configuration \| \| \| custom\_fields dictionary \| \| Must exist in Netbox and in key/value format \| \| \| description string \| \| The description of the prefix \| \| \| family integer \| \| Specifies which address family the prefix prefix belongs to \| \| \| is\_pool boolean \| Choices:* no * yes \| All IP Addresses within this prefix are considered usable \| \| \| parent raw \| \| Required if state is `present` and first\_available is `yes`. Will get a new available prefix in this parent prefix. \| \| \| prefix raw \| \| Required if state is `present` and first\_available is False. Will allocate or free this prefix. \| \| \| prefix\_length integer \| \| Required ONLY if state is `present` and first\_available is `yes`. Will get a new available prefix of the given prefix\_length in this parent prefix. \| \| \| prefix\_role raw \| \| The role of the prefix \| \| \| site raw \| \| Site that prefix is associated with \| \| \| status raw \| \| The status of the prefix \| \| \| tags list / elements=raw \| \| Any tags that the prefix may need to be associated with \| \| \| tenant raw \| \| The tenant that the prefix will be assigned to \| \| \| vlan raw \| \| The VLAN the prefix will be assigned to \| \| \| vrf raw \| \| VRF that prefix is associated with \| \| first\_available boolean \| Choices:* no ← * yes \| If `yes` and state `present`, if an parent is given, it will get the first available prefix of the given prefix\_length inside the given parent (and vrf, if given). Unused with state `absent`. \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox prefix module" connection: local hosts: localhost gather_facts: False tasks: - name: Create prefix within Netbox with only required information netbox_prefix: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 10.156.0.0/19 state: present - name: Delete prefix within netbox netbox_prefix: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 10.156.0.0/19 state: absent - name: Create prefix with several specified options netbox_prefix: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: family: 4 prefix: 10.156.32.0/19 site: Test Site vrf: Test VRF tenant: Test Tenant vlan: name: Test VLAN site: Test Site tenant: Test Tenant vlan_group: Test Vlan Group status: Reserved prefix_role: Network of care description: Test description is_pool: true tags: - Schnozzberry state: present - name: Get a new /24 inside 10.156.0.0/19 within Netbox - Parent doesn't exist netbox_prefix: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: parent: 10.156.0.0/19 prefix_length: 24 state: present first_available: yes - name: Create prefix within Netbox with only required information netbox_prefix: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: prefix: 10.156.0.0/19 state: present - name: Get a new /24 inside 10.156.0.0/19 within Netbox netbox_prefix: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: parent: 10.156.0.0/19 prefix_length: 24 state: present first_available: yes - name: Get a new /24 inside 10.157.0.0/19 within Netbox with additional values netbox_prefix: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: parent: 10.157.0.0/19 prefix_length: 24 vrf: Test VRF site: Test Site state: present first_available: yes ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| prefix dictionary \| on creation \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) * Anthony Ruhier (@Anthony25) ansible netbox.netbox.netbox_service – Creates or removes service from Netbox netbox.netbox.netbox\_service – Creates or removes service from Netbox ====================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_service`. New in version 0.1.5: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Creates or removes service from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the service configuration \| \| \| custom\_fields dictionary \| \| Must exist in Netbox and in key/value format \| \| \| description string \| \| Service description \| \| \| device raw \| \| Specifies on which device the service is running \| \| \| ipaddresses raw \| \| Specifies which IPaddresses to associate with service. \| \| \| name string / required \| \| Name of the region to be created \| \| \| port integer \| \| Specifies which port used by service \| \| \| ports list / elements=integer \| \| Specifies which ports used by service (NetBox 2.10 and newer) \| \| \| protocol raw / required \| \| Specifies which protocol used by service \| \| \| tags list / elements=raw \| \| What tags to add/update \| \| \| virtual\_machine raw \| \| Specifies on which virtual machine the service is running \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Create netbox service" connection: local hosts: all gather_facts: False tasks: - name: Create service netbox_service: netbox_url: netbox_url netbox_token: netbox_token data: device: Test666 name: node-exporter port: 9100 protocol: TCP ipaddresses: - address: 127.0.0.1 tags: - prometheus state: present - name: "Delete netbox service" connection: local hosts: all gather_facts: False tasks: - name: Delete service netbox_service: netbox_url: netbox_url netbox_token: netbox_token data: device: Test666 name: node-exporter port: 9100 protocol: TCP state: absent ``` ### Authors * Kulakov Ilya (@TawR1024) ansible netbox.netbox.netbox_provider – Create, update or delete providers within Netbox netbox.netbox.netbox\_provider – Create, update or delete providers within Netbox ================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_provider`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes providers from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the provider configuration \| \| \| account string \| \| The account number of the provider \| \| \| admin\_contact string \| \| The admin contact of the provider \| \| \| asn integer \| \| The provider ASN \| \| \| comments string \| \| Comments related to the provider \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| name string \| \| The name of the provider \| \| \| noc\_contact string \| \| The NOC contact of the provider \| \| \| portal\_url string \| \| The URL of the provider \| \| \| tags list / elements=raw \| \| Any tags that the device may need to be associated with \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create provider within Netbox with only required information netbox_provider: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Provider state: present - name: Update provider with other fields netbox_provider: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Provider asn: 65001 account: 200129104 portal_url: http://provider.net noc_contact: [email protected] admin_contact: [email protected] comments: "BAD PROVIDER" state: present - name: Delete provider within netbox netbox_provider: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Provider state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| provider dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_power_port – Create, update or delete power ports within Netbox netbox.netbox.netbox\_power\_port – Create, update or delete power ports within Netbox ====================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_power_port`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes power ports from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the power port configuration \| \| \| allocated\_draw integer \| \| The allocated draw of the power port in watt \| \| \| description string \| \| Description of the power port \| \| \| device raw / required \| \| The device the power port is attached to \| \| \| maximum\_draw integer \| \| The maximum permissible draw of the power port in watt \| \| \| name string / required \| \| The name of the power port \| \| \| tags list / elements=raw \| \| Any tags that the power port may need to be associated with \| \| \| type string \| Choices:* iec-60320-c6 * iec-60320-c8 * iec-60320-c14 * iec-60320-c16 * iec-60320-c20 * iec-60309-p-n-e-4h * iec-60309-p-n-e-6h * iec-60309-p-n-e-9h * iec-60309-2p-e-4h * iec-60309-2p-e-6h * iec-60309-2p-e-9h * iec-60309-3p-e-4h * iec-60309-3p-e-6h * iec-60309-3p-e-9h * iec-60309-3p-n-e-4h * iec-60309-3p-n-e-6h * iec-60309-3p-n-e-9h * nema-5-15p * nema-5-20p * nema-5-30p * nema-5-50p * nema-6-15p * nema-6-20p * nema-6-30p * nema-6-50p * nema-l5-15p * nema-l5-20p * nema-l5-30p * nema-l5-50p * nema-l6-20p * nema-l6-30p * nema-l6-50p * nema-l14-20p * nema-l14-30p * nema-l21-20p * nema-l21-30p * cs6361c * cs6365c * cs8165c * cs8265c * cs8365c * cs8465c * ita-e * ita-f * ita-ef * ita-g * ita-h * ita-i * ita-j * ita-k * ita-l * ita-m * ita-n * ita-o \| The type of the power port \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create power port within Netbox with only required information netbox_power_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port device: Test Device state: present - name: Update power port with other fields netbox_power_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port device: Test Device type: iec-60320-c6 allocated_draw: 16 maximum_draw: 80 description: power port description state: present - name: Delete power port within netbox netbox_power_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Port device: Test Device state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| power\_port dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb)	programming_docs
ansible netbox.netbox.netbox_device – Create, update or delete devices within Netbox netbox.netbox.netbox\_device – Create, update or delete devices within Netbox ============================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_device`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes devices from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the device configuration \| \| \| asset\_tag string \| \| Asset tag that is associated to the device \| \| \| cluster raw \| \| Cluster that the device will be assigned to \| \| \| comments string \| \| Comments that may include additional information in regards to the device \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| device\_role raw \| \| Required if state=present and the device does not exist yet \| \| \| device\_type raw \| \| Required if state=present and the device does not exist yet \| \| \| face string \| Choices:* Front * front * Rear * rear \| Required if rack is defined \| \| \| local\_context\_data dictionary \| \| Arbitrary JSON data to define the devices configuration variables. \| \| \| location raw added in 3.3.0 of netbox.netbox \| \| The location the device will be associated to (NetBox 2.11+) \| \| \| name string / required \| \| The name of the device \| \| \| platform raw \| \| The platform of the device \| \| \| position integer \| \| The position of the device in the rack defined above \| \| \| primary\_ip4 raw \| \| Primary IPv4 address assigned to the device \| \| \| primary\_ip6 raw \| \| Primary IPv6 address assigned to the device \| \| \| rack raw \| \| The name of the rack to assign the device to \| \| \| serial string \| \| Serial number of the device \| \| \| site raw \| \| Required if state=present and the device does not exist yet \| \| \| status raw \| \| The status of the device \| \| \| tags list / elements=raw \| \| Any tags that the device may need to be associated with \| \| \| tenant raw \| \| The tenant that the device will be assigned to \| \| \| vc\_position integer \| \| Position in the assigned virtual chassis \| \| \| vc\_priority integer \| \| Priority in the assigned virtual chassis \| \| \| virtual\_chassis raw \| \| Virtual chassis the device will be assigned to \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create device within Netbox with only required information netbox_device: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Device device_type: C9410R device_role: Core Switch site: Main state: present - name: Create device within Netbox with empty string name to generate UUID netbox_device: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "" device_type: C9410R device_role: Core Switch site: Main state: present - name: Delete device within netbox netbox_device: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Device state: absent - name: Create device with tags netbox_device: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Another Test Device device_type: C9410R device_role: Core Switch site: Main local_context_data: bgp: "65000" tags: - Schnozzberry state: present - name: Update the rack and position of an existing device netbox_device: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Device rack: Test Rack position: 10 face: Front state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| device dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket) * David Gomez (@amb1s1) ansible netbox.netbox.netbox_rir – Create, update or delete RIRs within Netbox netbox.netbox.netbox\_rir – Create, update or delete RIRs within Netbox ======================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_rir`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes RIRs from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the RIR configuration \| \| \| description string \| \| The description of the RIR \| \| \| is\_private boolean \| Choices:* no * yes \| IP space managed by this RIR is considered private \| \| \| name string / required \| \| The name of the RIR \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create RIR within Netbox with only required information netbox_rir: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test RIR One state: present - name: Update Test RIR One netbox_rir: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test RIR One is_private: True state: present - name: Delete RIR within netbox netbox_rir: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test RIR One state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| rir dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_ipam_role – Creates or removes ipam roles from Netbox netbox.netbox.netbox\_ipam\_role – Creates or removes ipam roles from Netbox ============================================================================ Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_ipam_role`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes ipam roles from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the ipam role configuration \| \| \| description string \| \| The description of the ipam role \| \| \| name string / required \| \| Name of the ipam role to be created \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| \| weight integer \| \| The weight of the ipam role to be created \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox module" connection: local hosts: localhost gather_facts: False tasks: - name: Create ipam role within Netbox with only required information netbox_ipam_role: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test IPAM Role state: present - name: Delete ipam role within netbox netbox_ipam_role: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test IPAM Role state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| role dictionary \| on creation \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_device_bay_template – Create, update or delete device bay templates within Netbox netbox.netbox.netbox\_device\_bay\_template – Create, update or delete device bay templates within Netbox ========================================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_device_bay_template`. New in version 0.3.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes device bay templates from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the device bay template configuration \| \| \| device\_type raw / required \| \| The device type the device bay template will be associated to. The device type must be "parent". \| \| \| name string / required \| \| The name of the device bay template \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create device bay template within Netbox with only required information netbox_device_bay_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: device bay template One device_type: Device Type One state: present - name: Delete device bay template within netbox netbox_device_bay_template: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: device bay template One device_type: Device Type One state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| device\_bay\_template dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_manufacturer – Create or delete manufacturers within Netbox netbox.netbox.netbox\_manufacturer – Create or delete manufacturers within Netbox ================================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_manufacturer`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes manufacturers from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the manufacturer configuration \| \| \| description string \| \| The description of the manufacturer \| \| \| name string / required \| \| The name of the manufacturer \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create manufacturer within Netbox with only required information netbox_manufacturer: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Manufacturer state: present - name: Delete manufacturer within netbox netbox_manufacturer: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Manufacturer state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| manufacturer dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Mikhail Yohman (@FragmentedPacket)	programming_docs
ansible netbox.netbox.netbox_vrf – Create, update or delete vrfs within Netbox netbox.netbox.netbox\_vrf – Create, update or delete vrfs within Netbox ======================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_vrf`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes vrfs from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the vrf configuration \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| description string \| \| The description of the vrf \| \| \| enforce\_unique boolean \| Choices:* no * yes \| Prevent duplicate prefixes/IP addresses within this VRF \| \| \| export\_targets list / elements=string added in 2.0.0 of netbox.netbox \| \| Export targets tied to VRF \| \| \| import\_targets list / elements=string added in 2.0.0 of netbox.netbox \| \| Import targets tied to VRF \| \| \| name string / required \| \| The name of the vrf \| \| \| rd string \| \| The RD of the VRF. Must be quoted to pass as a string. \| \| \| tags list / elements=raw \| \| Any tags that the vrf may need to be associated with \| \| \| tenant raw \| \| The tenant that the vrf will be assigned to \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create vrf within Netbox with only required information netbox_vrf: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test VRF state: present - name: Delete vrf within netbox netbox_vrf: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test VRF state: absent - name: Create vrf with all information netbox_vrf: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test VRF rd: "65000:1" tenant: Test Tenant enforce_unique: true import_targets: - "65000:65001" export_targets: - "65000:65001" description: VRF description tags: - Schnozzberry state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| vrf dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.nb_lookup – Queries and returns elements from Netbox netbox.netbox.nb\_lookup – Queries and returns elements from Netbox =================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.nb_lookup`. New in version 2.9: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Queries Netbox via its API to return virtually any information capable of being held in Netbox. * If wanting to obtain the plaintext attribute of a secret, private\_key or key\_file must be provided. Requirements ------------ The below requirements are needed on the local controller node that executes this lookup. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Configuration \| Comments \| \| --- \| --- \| --- \| --- \| \| \_terms string / required \| \| \| The Netbox object type to query \| \| api\_endpoint string / required \| \| env:NETBOX\_API env:NETBOX\_URL \| The URL to the Netbox instance to query \| \| api\_filter string \| \| \| The api\_filter to use. Filters should be key value pairs separated by a space. \| \| key\_file string \| \| \| The location of the private key tied to user account. Mutually exclusive with private\_key. \| \| plugin string \| \| \| The Netbox plugin to query \| \| private\_key string \| \| \| The private key as a string. Mutually exclusive with key\_file. \| \| raw\_data boolean \| Choices:* no * yes \| \| Whether to return raw API data with the lookup/query or whether to return a key/value dict \| \| token string \| \| env:NETBOX\_TOKEN env:NETBOX\_API\_TOKEN \| The API token created through Netbox This may not be required depending on the Netbox setup. \| \| validate\_certs string \| Default:"yes" \| \| Whether or not to validate SSL of the NetBox instance \| Examples -------- ``` tasks: # query a list of devices - name: Obtain list of devices from Netbox debug: msg: > "Device {{ item.value.display_name }} (ID: {{ item.key }}) was manufactured by {{ item.value.device_type.manufacturer.name }}" loop: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost/', token='<redacted>') }}" # This example uses an API Filter tasks: # query a list of devices - name: Obtain list of devices from Netbox debug: msg: > "Device {{ item.value.display_name }} (ID: {{ item.key }}) was manufactured by {{ item.value.device_type.manufacturer.name }}" loop: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost/', api_filter='role=management tag=Dell'), token='<redacted>') }}" # Obtain a secret for R1-device tasks: - name: "Obtain secrets for R1-Device" debug: msg: "{{ query('netbox.netbox.nb_lookup', 'secrets', api_filter='device=R1-Device', api_endpoint='http://localhost/', token='<redacted>', key_file='~/.ssh/id_rsa') }}" # Fetch bgp sessions for R1-device tasks: - name: "Obtain bgp sessions for R1-Device" debug: msg: "{{ query('netbox.netbox.nb_lookup', 'bgp_sessions', api_filter='device=R1-Device', api_endpoint='http://localhost/', token='<redacted>', plugin='mycustomstuff') }}" msg: "{{ query('netbox.netbox.nb_lookup', 'secrets', api_filter='device=R1-Device', api_endpoint='http://localhost/', token='<redacted>', key_file='~/.ssh/id_rsa') }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this lookup: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| \_list list / elements=string \| success \| list of composed dictionaries with key and value \| ### Authors * Chris Mills (@cpmills1975) ansible netbox.netbox.netbox_power_feed – Create, update or delete power feeds within Netbox netbox.netbox.netbox\_power\_feed – Create, update or delete power feeds within Netbox ====================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_power_feed`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes power feeds from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the power feed configuration \| \| \| amperage integer \| \| The amperage of the power feed \| \| \| comments string \| \| Comments related to the power feed \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| max\_utilization integer \| \| The maximum permissible draw of the power feed in percent \| \| \| name string / required \| \| The name of the power feed \| \| \| phase string \| Choices:* single-phase * three-phase \| The phase type of the power feed \| \| \| power\_panel raw / required \| \| The power panel the power feed is terminated on \| \| \| rack raw \| \| The rack the power feed is assigned to \| \| \| status string \| Choices:* offline * active * planned * failed \| The status of the power feed \| \| \| supply string \| Choices:* ac * dc \| The supply type of the power feed \| \| \| tags list / elements=raw \| \| Any tags that the power feed may need to be associated with \| \| \| type string \| Choices:* primary * redundant \| The type of the power feed \| \| \| voltage integer \| \| The voltage of the power feed \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create power feed within Netbox with only required information netbox_power_feed: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Feed power_panel: Test Power Panel state: present - name: Update power feed with other fields netbox_power_feed: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Feed power_panel: Test Power Panel status: offline type: primary supply: ac phase: single-phase voltage: 230 amperage: 16 max_utilization: 80 comments: normal power feed state: present - name: Delete power feed within netbox netbox_power_feed: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Power Feed power_panel: Test Power Panel state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| power\_feed dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_rack – Create, update or delete racks within Netbox netbox.netbox.netbox\_rack – Create, update or delete racks within Netbox ========================================================================= Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_rack`. New in version 0.1.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes racks from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the rack configuration \| \| \| asset\_tag string \| \| Asset tag that is associated to the rack \| \| \| comments string \| \| Comments that may include additional information in regards to the rack \| \| \| custom\_fields dictionary \| \| must exist in Netbox \| \| \| desc\_units boolean \| Choices:* no * yes \| Rack units will be numbered top-to-bottom \| \| \| facility\_id string \| \| The unique rack ID assigned by the facility \| \| \| location raw added in 3.1.0 of netbox.netbox \| \| The location the rack will be associated to (NetBox 2.11+) \| \| \| name string / required \| \| The name of the rack \| \| \| outer\_depth integer \| \| The outer depth of the rack \| \| \| outer\_unit string \| Choices:* Millimeters * Inches \| Whether the rack unit is in Millimeters or Inches and is required if outer\_width/outer\_depth is specified \| \| \| outer\_width integer \| \| The outer width of the rack \| \| \| rack\_group raw \| \| The rack group the rack will be associated to (NetBox < 2.11) Will be removed in version 5.0.0 \| \| \| rack\_role raw \| \| The rack role the rack will be associated to \| \| \| serial string \| \| Serial number of the rack \| \| \| site raw \| \| Required if state=present and the rack does not exist yet \| \| \| status raw \| \| The status of the rack \| \| \| tags list / elements=raw \| \| Any tags that the rack may need to be associated with \| \| \| tenant raw \| \| The tenant that the device will be assigned to \| \| \| type string \| Choices:* 2-post frame * 4-post frame * 4-post cabinet * Wall-mounted frame * Wall-mounted cabinet \| The type of rack \| \| \| u\_height integer \| \| The height of the rack in rack units \| \| \| width integer \| Choices:* 10 * 19 * 21 * 23 \| The rail-to-rail width \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create rack within Netbox with only required information netbox_rack: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test rack site: Test Site state: present - name: Create rack within Netbox with only required information - Pre 2.11 netbox_rack: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test rack site: Test Site rack_group: Test Rack Group state: present - name: Create rack within Netbox with only required information - Post 2.11 netbox_rack: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test rack site: Test Site location: Test Location state: present - name: Delete rack within netbox netbox_rack: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rack state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| rack dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Mikhail Yohman (@FragmentedPacket) ansible netbox.netbox.netbox_front_port – Create, update or delete front ports within Netbox netbox.netbox.netbox\_front\_port – Create, update or delete front ports within Netbox ====================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_front_port`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes front ports from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the front port configuration \| \| \| description string \| \| Description of the front port \| \| \| device raw / required \| \| The device the front port is attached to \| \| \| name string / required \| \| The name of the front port \| \| \| rear\_port raw / required \| \| The rear\_port the front port is attached to \| \| \| rear\_port\_position integer \| \| The position of the rear port this front port is connected to \| \| \| tags list / elements=raw \| \| Any tags that the front port may need to be associated with \| \| \| type string / required \| Choices:* 8p8c * 110-punch * bnc * mrj21 * fc * lc * lc-apc * lsh * lsh-apc * mpo * mtrj * sc * sc-apc * st \| The type of the front port \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create front port within Netbox with only required information netbox_front_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Front Port device: Test Device type: bnc rear_port: Test Rear Port state: present - name: Update front port with other fields netbox_front_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Front Port device: Test Device type: bnc rear_port: Test Rear Port rear_port_position: 5 description: front port description state: present - name: Delete front port within netbox netbox_front_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Front Port device: Test Device type: bnc rear_port: Test Rear Port state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| front\_port dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| ### Authors * Tobias Groß (@toerb)	programming_docs
ansible netbox.netbox.netbox_rear_port – Create, update or delete rear ports within Netbox netbox.netbox.netbox\_rear\_port – Create, update or delete rear ports within Netbox ==================================================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_rear_port`. New in version 0.2.3: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates, updates or removes rear ports from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the rear port configuration \| \| \| description string \| \| Description of the rear port \| \| \| device raw / required \| \| The device the rear port is attached to \| \| \| name string / required \| \| The name of the rear port \| \| \| positions integer \| \| The number of front ports which may be mapped to each rear port \| \| \| tags list / elements=raw \| \| Any tags that the rear port may need to be associated with \| \| \| type string / required \| Choices:* 8p8c * 110-punch * bnc * mrj21 * fc * lc * lc-apc * lsh * lsh-apc * mpo * mtrj * sc * sc-apc * st \| The type of the rear port \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test Netbox modules" connection: local hosts: localhost gather_facts: False tasks: - name: Create rear port within Netbox with only required information netbox_rear_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port device: Test Device type: bnc state: present - name: Update rear port with other fields netbox_rear_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port device: Test Device type: bnc positions: 5 description: rear port description state: present - name: Delete rear port within netbox netbox_rear_port: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: Test Rear Port device: Test Device type: bnc state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| rear\_port dictionary \| success (when state=present) \| Serialized object as created or already existent within Netbox \| ### Authors * Tobias Groß (@toerb) ansible netbox.netbox.netbox_tag – Creates or removes tags from Netbox netbox.netbox.netbox\_tag – Creates or removes tags from Netbox =============================================================== Note This plugin is part of the [netbox.netbox collection](https://galaxy.ansible.com/netbox/netbox) (version 3.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netbox.netbox`. To use it in a playbook, specify: `netbox.netbox.netbox_tag`. New in version 1.2.0: of netbox.netbox * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Creates or removes tags from Netbox Requirements ------------ The below requirements are needed on the host that executes this module. * pynetbox Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert raw \| \| Certificate path \| \| data dictionary / required \| \| Defines the tag configuration \| \| \| color string \| \| Tag color \| \| \| description string \| \| Tag description \| \| \| name string / required \| \| Tag name \| \| \| slug string \| \| The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided \| \| netbox\_token string / required \| \| The token created within Netbox to authorize API access \| \| netbox\_url string / required \| \| URL of the Netbox instance resolvable by Ansible control host \| \| query\_params list / elements=string \| \| This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that is defined in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make an object unique in their environment. \| \| state string \| Choices:* absent * present ← \| Use `present` or `absent` for adding or removing. \| \| validate\_certs raw \| Default:"yes" \| If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. \| Notes ----- Note * Tags should be defined as a YAML list * This should be ran with connection `local` and hosts `localhost` Examples -------- ``` - name: "Test tags creation/deletion" connection: local hosts: localhost gather_facts: False tasks: - name: Create tags netbox_tag: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "{{ item.name }}" description: "{{ item.description }}" loop: - { name: mgmt, description: "management" } - { name: tun, description: "tunnel" } - name: Delete tags netbox_tag: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: name: "{{ item }}" state: absent loop: - mgmt - tun ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Message indicating failure or info about what has been achieved \| \| tags dictionary \| always \| Serialized object as created/existent/updated/deleted within Netbox \| ### Authors * Pavel Korovin (@pkorovin) ansible Collections in the Netapp Namespace Collections in the Netapp Namespace =================================== These are the collections with docs hosted on [docs.ansible.com](https://docs.ansible.com/) in the netapp namespace. * [netapp.aws](aws/index#plugins-in-netapp-aws) * [netapp.azure](azure/index#plugins-in-netapp-azure) * [netapp.cloudmanager](cloudmanager/index#plugins-in-netapp-cloudmanager) * [netapp.elementsw](elementsw/index#plugins-in-netapp-elementsw) * [netapp.ontap](ontap/index#plugins-in-netapp-ontap) * [netapp.um\_info](um_info/index#plugins-in-netapp-um-info) ansible Netapp.Azure Netapp.Azure ============ Collection version 21.9.0 Plugin Index ------------ These are the plugins in the netapp.azure collection ### Modules * [azure\_rm\_netapp\_account](azure_rm_netapp_account_module#ansible-collections-netapp-azure-azure-rm-netapp-account-module) – Manage NetApp Azure Files Account * [azure\_rm\_netapp\_capacity\_pool](azure_rm_netapp_capacity_pool_module#ansible-collections-netapp-azure-azure-rm-netapp-capacity-pool-module) – Manage NetApp Azure Files capacity pool * [azure\_rm\_netapp\_snapshot](azure_rm_netapp_snapshot_module#ansible-collections-netapp-azure-azure-rm-netapp-snapshot-module) – Manage NetApp Azure Files Snapshot * [azure\_rm\_netapp\_volume](azure_rm_netapp_volume_module#ansible-collections-netapp-azure-azure-rm-netapp-volume-module) – Manage NetApp Azure Files Volume See also List of [collections](../../index#list-of-collections) with docs hosted here. ansible netapp.azure.azure_rm_netapp_capacity_pool – Manage NetApp Azure Files capacity pool netapp.azure.azure\_rm\_netapp\_capacity\_pool – Manage NetApp Azure Files capacity pool ======================================================================================== Note This plugin is part of the [netapp.azure collection](https://galaxy.ansible.com/netapp/azure) (version 21.9.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.azure`. To use it in a playbook, specify: `netapp.azure.azure_rm_netapp_capacity_pool`. New in version 19.10.0: of netapp.azure * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) Synopsis -------- * Create and delete NetApp Azure capacity pool. Provide the Resource group name for the capacity pool to be created. * Resize NetApp Azure capacity pool Requirements ------------ The below requirements are needed on the host that executes this module. * All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection * For authentication with Azure NetApp log in before you run your tasks or playbook with `az login`. * Full installation instructions may be found <https://galaxy.ansible.com/azure/azcollection> * Python azure-mgmt-netapp. Install using ‘pip install azure-mgmt-netapp’ * Python azure-mgmt. Install using ‘pip install azure-mgmt’ * The host that executes this module must have the azure.azcollection collection installed via galaxy * azure >= 2.0.0 * python >= 2.7 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_name string / required \| \| The name of the NetApp account. \| \| ad\_user string \| \| Active Directory username. Use when authenticating with an Active Directory user rather than service principal. \| \| adfs\_authority\_url string added in 0.0.1 of netapp.azure \| \| Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. \| \| api\_profile string added in 0.0.1 of netapp.azure \| Default:"latest" \| Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack. \| \| append\_tags boolean \| Choices:* no * yes ← \| Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. \| \| auth\_source string added in 0.0.1 of netapp.azure \| Choices:* auto ← * cli * credential\_file * env * msi \| Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6. \| \| cert\_validation\_mode string added in 0.0.1 of netapp.azure \| Choices:* ignore * validate \| Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable. \| \| client\_id string \| \| Azure client ID. Use when authenticating with a Service Principal. \| \| cloud\_environment string added in 0.0.1 of netapp.azure \| Default:"AzureCloud" \| For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable. \| \| location string \| \| Resource location. Required for create. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the capacity pool. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| resource\_group string / required \| \| Name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| service\_level string added in 20.5.0 of netapp.azure \| Choices:* Standard * Premium * Ultra \| The service level of the file system. Required for create. \| \| size integer \| Default:1 \| Provisioned size of the pool (in chunks). Allowed values are in 4TiB chunks. Provide number to be multiplied to 4TiB. Required for create. \| \| state string \| Choices:* present ← * absent \| State `present` will check that the capacity pool exists with the requested configuration. State `absent` will delete the capacity pool. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags dictionary \| \| Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append\_tags option to false. Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. Azure Front Door doesn't support the use of Azure Automation and Azure CDN only support 15 tags on resources. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| Notes ----- Note * For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with `az login`. * Authentication is also possible using a service principal or Active Directory user. * To authenticate via service principal, pass subscription\_id, client\_id, secret and tenant or set environment variables AZURE\_SUBSCRIPTION\_ID, AZURE\_CLIENT\_ID, AZURE\_SECRET and AZURE\_TENANT. * To authenticate via Active Directory user, pass ad\_user and password, or set AZURE\_AD\_USER and AZURE\_PASSWORD in the environment. * Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription\_id, client\_id, secret and tenant or subscription\_id, ad\_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE\_PROFILE in the environment. * The modules prefixed with azure\_rm\_netapp are built to support the Cloud Volume Services for Azure NetApp Files. See Also -------- See also [Sign in with Azure CLI](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. [Sign in with Azure CLI](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create Azure NetApp capacity pool netapp.azure.azure_rm_netapp_capacity_pool: resource_group: myResourceGroup account_name: tests-netapp name: tests-pool location: eastus size: 2 service_level: Standard - name: Resize Azure NetApp capacity pool netapp.azure.azure_rm_netapp_capacity_pool: resource_group: myResourceGroup account_name: tests-netapp name: tests-pool location: eastus size: 3 service_level: Standard - name: Delete Azure NetApp capacity pool netapp.azure.azure_rm_netapp_capacity_pool: state: absent resource_group: myResourceGroup account_name: tests-netapp name: tests-pool ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#a8c6cf85c9c6dbc1cac4cddccdc9c58e8b9b9f938e8b9d9a938e8b9c9093c6cddcc9d8d88e8b9c9e93cbc7c5)> ansible netapp.azure.azure_rm_netapp_snapshot – Manage NetApp Azure Files Snapshot netapp.azure.azure\_rm\_netapp\_snapshot – Manage NetApp Azure Files Snapshot ============================================================================= Note This plugin is part of the [netapp.azure collection](https://galaxy.ansible.com/netapp/azure) (version 21.9.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.azure`. To use it in a playbook, specify: `netapp.azure.azure_rm_netapp_snapshot`. New in version 19.10.0: of netapp.azure * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) Synopsis -------- * Create and delete NetApp Azure Snapshot. Requirements ------------ The below requirements are needed on the host that executes this module. * All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection * For authentication with Azure NetApp log in before you run your tasks or playbook with `az login`. * Full installation instructions may be found <https://galaxy.ansible.com/azure/azcollection> * Python azure-mgmt-netapp. Install using ‘pip install azure-mgmt-netapp’ * Python azure-mgmt. Install using ‘pip install azure-mgmt’ * The host that executes this module must have the azure.azcollection collection installed via galaxy * azure >= 2.0.0 * python >= 2.7 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_name string / required \| \| The name of the NetApp account. \| \| ad\_user string \| \| Active Directory username. Use when authenticating with an Active Directory user rather than service principal. \| \| adfs\_authority\_url string added in 0.0.1 of netapp.azure \| \| Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. \| \| api\_profile string added in 0.0.1 of netapp.azure \| Default:"latest" \| Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack. \| \| auth\_source string added in 0.0.1 of netapp.azure \| Choices:* auto ← * cli * credential\_file * env * msi \| Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6. \| \| cert\_validation\_mode string added in 0.0.1 of netapp.azure \| Choices:* ignore * validate \| Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable. \| \| client\_id string \| \| Azure client ID. Use when authenticating with a Service Principal. \| \| cloud\_environment string added in 0.0.1 of netapp.azure \| Default:"AzureCloud" \| For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable. \| \| location string \| \| Resource location. Required for create. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the snapshot. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| pool\_name string / required \| \| The name of the capacity pool. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| resource\_group string / required \| \| Name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| State `present` will check that the snapshot exists with the requested configuration. State `absent` will delete the snapshot. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| volume\_name string / required \| \| The name of the volume. \| Notes ----- Note * For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with `az login`. * Authentication is also possible using a service principal or Active Directory user. * To authenticate via service principal, pass subscription\_id, client\_id, secret and tenant or set environment variables AZURE\_SUBSCRIPTION\_ID, AZURE\_CLIENT\_ID, AZURE\_SECRET and AZURE\_TENANT. * To authenticate via Active Directory user, pass ad\_user and password, or set AZURE\_AD\_USER and AZURE\_PASSWORD in the environment. * Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription\_id, client\_id, secret and tenant or subscription\_id, ad\_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE\_PROFILE in the environment. * The modules prefixed with azure\_rm\_netapp are built to support the Cloud Volume Services for Azure NetApp Files. See Also -------- See also [Sign in with Azure CLI](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. [Sign in with Azure CLI](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create Azure NetApp Snapshot netapp.azure.azure_rm_netapp_snapshot: resource_group: myResourceGroup account_name: tests-netapp pool_name: tests-pool volume_name: tests-volume2 name: tests-snapshot location: eastus - name: Delete Azure NetApp Snapshot netapp.azure.azure_rm_netapp_snapshot: state: absent resource_group: myResourceGroup account_name: tests-netapp pool_name: tests-pool volume_name: tests-volume2 name: tests-snapshot ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#a3cdc48ec2cdd0cac1cfc6d7c6c2ce858090949885809691988580979b98cdc6d7c2d3d38580979598c0ccce)>	programming_docs
ansible netapp.azure.azure_rm_netapp_account – Manage NetApp Azure Files Account netapp.azure.azure\_rm\_netapp\_account – Manage NetApp Azure Files Account =========================================================================== Note This plugin is part of the [netapp.azure collection](https://galaxy.ansible.com/netapp/azure) (version 21.9.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.azure`. To use it in a playbook, specify: `netapp.azure.azure_rm_netapp_account`. New in version 19.10.0: of netapp.azure * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) Synopsis -------- * Create and delete NetApp Azure account. Provide the Resource group name for the NetApp account to be created. Requirements ------------ The below requirements are needed on the host that executes this module. * All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection * For authentication with Azure NetApp log in before you run your tasks or playbook with `az login`. * Full installation instructions may be found <https://galaxy.ansible.com/azure/azcollection> * Python azure-mgmt-netapp. Install using ‘pip install azure-mgmt-netapp’ * Python azure-mgmt. Install using ‘pip install azure-mgmt’ * The host that executes this module must have the azure.azcollection collection installed via galaxy * azure >= 2.0.0 * python >= 2.7 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| active\_directories list / elements=dictionary added in 21.2.0 of netapp.azure \| \| list of active directory dictionaries. The list is currently limited to a single active directory (ANF or Azure limit of one AD per subscription). \| \| \| active\_directory\_id string \| \| not used for create. Not needed for join. \| \| \| ad\_name string added in 21.3.0 of netapp.azure \| \| Name of the active directory machine. Used only while creating kerberos volume. \| \| \| aes\_encryption boolean \| Choices:* no * yes \| If enabled, AES encryption will be enabled for SMB communication. \| \| \| dns list / elements=string \| \| list of DNS addresses. Required for create or join. \| \| \| domain string \| \| Fully Qualified Active Directory DNS Domain Name. Required for create or join. \| \| \| kdc\_ip string added in 21.3.0 of netapp.azure \| \| kdc server IP addresses for the active directory machine. Used only while creating kerberos volume. \| \| \| ldap\_signing boolean \| Choices:* no * yes \| Specifies whether or not the LDAP traffic needs to be signed. \| \| \| organizational\_unit string \| \| LDAP Path for the Organization Unit where SMB Server machine accounts will be created (i.e. OU=SecondLevel,OU=FirstLevel). \| \| \| password string \| \| see username. If password is present, the module is not idempotent, as we cannot check the current value. Required for create or join. \| \| \| server\_root\_ca\_certificate string added in 21.3.0 of netapp.azure \| \| When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes. \| \| \| site string \| \| The Active Directory site the service will limit Domain Controller discovery to. \| \| \| smb\_server\_name string \| \| Prefix for creating the SMB server's computer account name in the Active Directory domain. Required for create or join. \| \| \| username string \| \| Credentials that have permissions to create SMB server machine account in the AD domain. Required for create or join. \| \| ad\_user string \| \| Active Directory username. Use when authenticating with an Active Directory user rather than service principal. \| \| adfs\_authority\_url string added in 0.0.1 of netapp.azure \| \| Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. \| \| api\_profile string added in 0.0.1 of netapp.azure \| Default:"latest" \| Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack. \| \| append\_tags boolean \| Choices:* no * yes ← \| Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. \| \| auth\_source string added in 0.0.1 of netapp.azure \| Choices:* auto ← * cli * credential\_file * env * msi \| Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6. \| \| cert\_validation\_mode string added in 0.0.1 of netapp.azure \| Choices:* ignore * validate \| Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable. \| \| client\_id string \| \| Azure client ID. Use when authenticating with a Service Principal. \| \| cloud\_environment string added in 0.0.1 of netapp.azure \| Default:"AzureCloud" \| For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable. \| \| debug boolean \| Choices:* no ← * yes \| output details about current account if it exists. \| \| location string \| \| Resource location. Required for create. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the NetApp account. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| resource\_group string / required \| \| Name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| state string \| Choices:* absent * present ← \| State `present` will check that the NetApp account exists with the requested configuration. State `absent` will delete the NetApp account. \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags dictionary \| \| Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append\_tags option to false. Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. Azure Front Door doesn't support the use of Azure Automation and Azure CDN only support 15 tags on resources. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| Notes ----- Note * For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with `az login`. * Authentication is also possible using a service principal or Active Directory user. * To authenticate via service principal, pass subscription\_id, client\_id, secret and tenant or set environment variables AZURE\_SUBSCRIPTION\_ID, AZURE\_CLIENT\_ID, AZURE\_SECRET and AZURE\_TENANT. * To authenticate via Active Directory user, pass ad\_user and password, or set AZURE\_AD\_USER and AZURE\_PASSWORD in the environment. * Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription\_id, client\_id, secret and tenant or subscription\_id, ad\_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE\_PROFILE in the environment. * The modules prefixed with azure\_rm\_netapp are built to support the Cloud Volume Services for Azure NetApp Files. See Also -------- See also [Sign in with Azure CLI](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. [Sign in with Azure CLI](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create NetApp Azure Account netapp.azure.azure_rm_netapp_account: resource_group: myResourceGroup name: testaccount location: eastus tags: {'abc': 'xyz', 'cba': 'zyx'} - name: Modify Azure NetApp account (Join AD) netapp.azure.azure_rm_netapp_account: resource_group: myResourceGroup name: testaccount location: eastus active_directories: - site: ln dns: 10.10.10.10 domain: domain.com smb_server_name: dummy password: xxxxxx username: laurentn - name: Delete NetApp Azure Account netapp.azure.azure_rm_netapp_account: state: absent resource_group: myResourceGroup name: testaccount location: eastus - name: Create Azure NetApp account (with AD) netapp.azure.azure_rm_netapp_account: resource_group: laurentngroupnodash name: tests-netapp11 location: eastus tags: creator: laurentn use: Ansible active_directories: - site: ln dns: 10.10.10.10 domain: domain.com smb_server_name: dummy password: xxxxxx username: laurentn ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#7c121b511d120f151e101908191d115a5f4f4b475a5f494e475a5f4844471219081d0c0c5a5f484a471f1311)> ansible netapp.azure.azure_rm_netapp_volume – Manage NetApp Azure Files Volume netapp.azure.azure\_rm\_netapp\_volume – Manage NetApp Azure Files Volume ========================================================================= Note This plugin is part of the [netapp.azure collection](https://galaxy.ansible.com/netapp/azure) (version 21.9.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.azure`. To use it in a playbook, specify: `netapp.azure.azure_rm_netapp_volume`. New in version 19.10.0: of netapp.azure * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [See Also](#see-also) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create and delete NetApp Azure volume. Requirements ------------ The below requirements are needed on the host that executes this module. * All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection * For authentication with Azure NetApp log in before you run your tasks or playbook with `az login`. * Full installation instructions may be found <https://galaxy.ansible.com/azure/azcollection> * Python azure-mgmt-netapp. Install using ‘pip install azure-mgmt-netapp’ * Python azure-mgmt. Install using ‘pip install azure-mgmt’ * The host that executes this module must have the azure.azcollection collection installed via galaxy * azure >= 2.0.0 * python >= 2.7 Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_name string / required \| \| The name of the NetApp account. \| \| ad\_user string \| \| Active Directory username. Use when authenticating with an Active Directory user rather than service principal. \| \| adfs\_authority\_url string added in 0.0.1 of netapp.azure \| \| Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. \| \| api\_profile string added in 0.0.1 of netapp.azure \| Default:"latest" \| Selects an API profile to use when communicating with Azure services. Default value of `latest` is appropriate for public clouds; future values will allow use with Azure Stack. \| \| append\_tags boolean \| Choices:* no * yes ← \| Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. \| \| auth\_source string added in 0.0.1 of netapp.azure \| Choices:* auto ← * cli * credential\_file * env * msi \| Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. When set to `msi`, the host machine must be an azure resource with an enabled MSI extension. `subscription_id` or the environment variable `AZURE_SUBSCRIPTION_ID` can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen. The `msi` was added in Ansible 2.6. \| \| cert\_validation\_mode string added in 0.0.1 of netapp.azure \| Choices:* ignore * validate \| Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing `ignore`. Can also be set via credential file profile or the `AZURE_CERT_VALIDATION` environment variable. \| \| client\_id string \| \| Azure client ID. Use when authenticating with a Service Principal. \| \| cloud\_environment string added in 0.0.1 of netapp.azure \| Default:"AzureCloud" \| For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, `AzureChinaCloud`, `AzureUSGovernment`), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the `AZURE_CLOUD_ENVIRONMENT` environment variable. \| \| feature\_flags dictionary added in 21.9.0 of netapp.azure \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| file\_path string \| \| A unique file path for the volume. Used when creating mount targets. \| \| location string \| \| Resource location. Required for create. \| \| log\_mode string \| \| Parent argument. \| \| log\_path string \| \| Parent argument. \| \| name string / required \| \| The name of the volume. \| \| password string \| \| Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. \| \| pool\_name string / required \| \| The name of the capacity pool. \| \| profile string \| \| Security profile found in ~/.azure/credentials file. \| \| protocol\_types list / elements=string added in 21.2.0 of netapp.azure \| \| Protocol types - NFSv3, NFSv4.1, CIFS (for SMB). \| \| resource\_group string / required \| \| Name of the resource group. \| \| secret string \| \| Azure client secret. Use when authenticating with a Service Principal. \| \| service\_level string \| Choices:* Premium * Standard * Ultra \| The service level of the file system. default is Premium. \| \| size integer added in 20.5.0 of netapp.azure \| \| Provisioned size of the volume (in GiB). Minimum size is 100 GiB. Upper limit is 100TiB default is 100GiB. \| \| state string \| Choices:* present ← * absent \| State `present` will check that the volume exists with the requested configuration. State `absent` will delete the volume. \| \| subnet\_name string added in 21.1.0 of netapp.azure \| \| Azure resource name for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Provide name of the subnet ID. Required for create. aliases: subnet\_id \| \| subscription\_id string \| \| Your Azure subscription Id. \| \| tags dictionary \| \| Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append\_tags option to false. Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. Azure Front Door doesn't support the use of Azure Automation and Azure CDN only support 15 tags on resources. \| \| tenant string \| \| Azure tenant ID. Use when authenticating with a Service Principal. \| \| virtual\_network string \| \| The name of the virtual network required for the subnet to create a volume. Required for create. \| \| vnet\_resource\_group\_for\_subnet string added in 20.5.0 of netapp.azure \| \| Only required if virtual\_network to be used is of different resource\_group. Name of the resource group for virtual\_network and subnet\_name to be used. \| Notes ----- Note * feature\_flags is setting ignore\_change\_ownership\_mode to true by default to bypass a ‘change ownership mode’ issue with azure-mgmt-netapp 4.0.0. * For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with `az login`. * Authentication is also possible using a service principal or Active Directory user. * To authenticate via service principal, pass subscription\_id, client\_id, secret and tenant or set environment variables AZURE\_SUBSCRIPTION\_ID, AZURE\_CLIENT\_ID, AZURE\_SECRET and AZURE\_TENANT. * To authenticate via Active Directory user, pass ad\_user and password, or set AZURE\_AD\_USER and AZURE\_PASSWORD in the environment. * Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription\_id, client\_id, secret and tenant or subscription\_id, ad\_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE\_PROFILE in the environment. * The modules prefixed with azure\_rm\_netapp are built to support the Cloud Volume Services for Azure NetApp Files. See Also -------- See also [Sign in with Azure CLI](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. [Sign in with Azure CLI](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) How to authenticate using the `az login` command. Examples -------- ``` - name: Create Azure NetApp volume netapp.azure.azure_rm_netapp_volume: resource_group: myResourceGroup account_name: tests-netapp pool_name: tests-pool name: tests-volume2 location: eastus file_path: tests-volume2 virtual_network: myVirtualNetwork vnet_resource_group_for_subnet: myVirtualNetworkResourceGroup subnet_name: test service_level: Ultra size: 100 - name: Delete Azure NetApp volume netapp.azure.azure_rm_netapp_volume: state: absent resource_group: myResourceGroup account_name: tests-netapp pool_name: tests-pool name: tests-volume2 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| mount\_path string \| always \| Returns mount\_path of the Volume \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#503e377d313e2339323c352435313d767363676b767365626b767364686b3e3524312020767364666b333f3d)>	programming_docs
ansible netapp.ontap.na_ontap_nvme_subsystem – NetApp ONTAP Manage NVME Subsystem netapp.ontap.na\_ontap\_nvme\_subsystem – NetApp ONTAP Manage NVME Subsystem ============================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_nvme_subsystem`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete NVME subsystem * Associate(modify) host/map to NVME subsystem * NVMe service should be existing in the data vserver with NVMe protocol as a pre-requisite Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| hosts list / elements=string \| \| List of host NQNs (NVMe Qualification Name) associated to the controller. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| ostype string \| Choices:* windows * linux * vmware * xen * hyper\_v \| Specifies the ostype for initiators \| \| password string \| \| Password for the specified user. aliases: pass \| \| paths list / elements=string \| \| List of Namespace paths to be associated with the subsystem. \| \| skip\_host\_check boolean \| Choices:* no ← * yes \| Skip host check Required to delete an NVMe Subsystem with attached NVMe namespaces \| \| skip\_mapped\_check boolean \| Choices:* no ← * yes \| Skip mapped namespace check Required to delete an NVMe Subsystem with attached NVMe namespaces \| \| state string \| Choices:* present ← * absent \| Whether the specified subsystem should exist or not. \| \| subsystem string / required \| \| Specifies the subsystem \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create NVME Subsystem na_ontap_nvme_subsystem: state: present subsystem: test_sub vserver: test_dest ostype: linux hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete NVME Subsystem na_ontap_nvme_subsystem: state: absent subsystem: test_sub vserver: test_dest skip_host_check: True skip_mapped_check: True hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Associate NVME Subsystem host/map na_ontap_nvme_subsystem: state: present subsystem: "{{ subsystem }}" ostype: linux hosts: nqn.1992-08.com.netapp:sn.3017cfc1e2ba11e89c55005056b36338:subsystem.ansible paths: /vol/ansible/test,/vol/ansible/test1 vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Modify NVME subsystem map na_ontap_nvme_subsystem: state: present subsystem: test_sub vserver: test_dest skip_host_check: True skip_mapped_check: True paths: /vol/ansible/test hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#016f662c606f7268636d647564606c272232363a272234333a272235393a6f6475607171272235373a626e6c)> ansible netapp.ontap.na_ontap_vscan – NetApp ONTAP Vscan enable/disable. netapp.ontap.na\_ontap\_vscan – NetApp ONTAP Vscan enable/disable. ================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_vscan`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable and Disable Vscan Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| enable boolean \| Choices:* no * yes ← \| Whether to enable to disable a Vscan \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| the name of the data vserver to use. \| Notes ----- Note * on demand task, on\_access\_policy and scanner\_pools must be set up before running this module * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Enable Vscan na_ontap_vscan: enable: True username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: trident_svm - name: Disable Vscan na_ontap_vscan: enable: False username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: trident_svm ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#523c357f333c213b303e372637333f747161656974716760697471666a693c37263322227471666469313d3f)> ansible netapp.ontap.na_ontap_snaplock_clock – NetApp ONTAP Sets the snaplock compliance clock. netapp.ontap.na\_ontap\_snaplock\_clock – NetApp ONTAP Sets the snaplock compliance clock. ========================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_snaplock_clock`. New in version 21.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Sets the Snaplock compliance clock on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| node string / required \| \| Name of the node to set compliance clock on. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Set node compliance clock na_ontap_snaplock_clock: node: cluster1-01 hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#5739307a3639243e353b322332363a717464606c717462656c7174636f6c393223362727717463616c34383a)> ansible netapp.ontap.na_ontap_zapit – NetApp ONTAP Run any ZAPI on ONTAP netapp.ontap.na\_ontap\_zapit – NetApp ONTAP Run any ZAPI on ONTAP ================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_zapit`. New in version 20.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Call a ZAPI on ONTAP. * Cluster ZAPIs are run using a cluster admin account. * Vserver ZAPIs can be run using a vsadmin account or using vserver tunneling (cluster admin with vserver option). * In case of success, a json dictionary is returned as `response`. * In case of a ZAPI error, `status`, `errno`, `reason` are set to help with diagnosing the issue, * and the call is reported as an error (‘failed’). * Other errors (eg connection issues) are reported as Ansible error. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string \| \| if provided, forces vserver tunneling. username identifies a cluster admin account. \| \| zapi dictionary / required \| \| A dictionary for the zapi and arguments. An XML tag <tag>value</tag> is a dictionary with tag as the key. Value can be another dictionary, a list of dictionaries, a string, or nothing. eg <tag/> is represented as tag: A single zapi can be called at a time. Ansible warns if duplicate keys are found and only uses the last entry. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Ontap ZAPI hosts: localhost gather_facts: False collections: - netapp.ontap vars: login: &login hostname: "{{ admin_ip }}" username: "{{ admin_username }}" password: "{{ admin_password }}" https: true validate_certs: false svm_login: &svm_login hostname: "{{ svm_admin_ip }}" username: "{{ svm_admin_username }}" password: "{{ svm_admin_password }}" https: true validate_certs: false tasks: - name: run ontap ZAPI command as cluster admin na_ontap_zapit: <<: login zapi: system-get-version: register: output - debug: var=output - name: run ontap ZAPI command as cluster admin na_ontap_zapit: <<: login zapi: vserver-get-iter: register: output - debug: var=output - name: run ontap ZAPI command as cluster admin na_ontap_zapit: <<: login zapi: vserver-get-iter: desired-attributes: vserver-info: - aggr-list: - aggr-name - allowed-protocols: - protocols - vserver-aggr-info-list: - vserser-aggr-info - uuid query: vserver-info: vserver-name: trident_svm register: output - debug: var=output - name: run ontap ZAPI command as vsadmin na_ontap_zapit: <<: svm_login zapi: vserver-get-iter: desired-attributes: vserver-info: - uuid register: output - debug: var=output - name: run ontap ZAPI command as vserver tunneling na_ontap_zapit: <<: login vserver: trident_svm zapi: vserver-get-iter: desired-attributes: vserver-info: - uuid register: output - debug: var=output - name: run ontap active-directory ZAPI command na_ontap_zapit: <<: login vserver: trident_svm zapi: active-directory-account-create: account-name: testaccount admin-username: testuser admin-password: testpass domain: testdomain organizational-unit: testou register: output ignore_errors: True - debug: var=output ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| errno string \| On error \| If the ZAPI was executed but failed, the error code set by the ZAPI. Not present if successful, or if the ZAPI call cannot be performed. \| \| reason string \| On error \| If the ZAPI was executed but failed, the error reason set by the ZAPI. Not present if successful, or if the ZAPI call cannot be performed. \| \| response dictionary \| On success \| If successful, a json dictionary representing the data returned by the ZAPI. If the ZAPI was executed but failed, an empty dictionary. Not present if the ZAPI call cannot be performed. \| \| status string \| On error \| If the ZAPI was executed but failed, the status set by the ZAPI. Not present if successful, or if the ZAPI call cannot be performed. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#127c753f737c617b707e776677737f343121252934312720293431262a297c77667362623431262429717d7f)>	programming_docs
ansible netapp.ontap.na_ontap_kerberos_realm – NetApp ONTAP vserver nfs kerberos realm netapp.ontap.na\_ontap\_kerberos\_realm – NetApp ONTAP vserver nfs kerberos realm ================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_kerberos_realm`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify or delete vserver kerberos realm configuration Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| ad\_server\_ip string added in 20.4.0 of netapp.ontap \| \| IP Address of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is 'microsoft'. \| \| ad\_server\_name string added in 20.4.0 of netapp.ontap \| \| Host name of the Active Directory Domain Controller (DC). This is a mandatory parameter if the kdc-vendor is 'microsoft'. \| \| admin\_server\_ip string \| \| IP address of the host where the Kerberos administration daemon is running. This is usually the master KDC. If this parameter is omitted, the address specified in kdc\_ip is used. \| \| admin\_server\_port string \| \| The TCP port on the Kerberos administration server where the Kerberos administration service is running. The default for this parmater is '749' \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| clock\_skew string \| \| The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host's system clock. The default for this parameter is '5' minutes. \| \| comment string \| \| Optional comment \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| kdc\_ip string \| \| IP address of the Key Distribution Centre (KDC) server Required if state=present \| \| kdc\_port string \| \| TCP port on the KDC to be used for Kerberos communication. The default for this parameter is '88'. \| \| kdc\_vendor string \| Choices:* other * microsoft \| The vendor of the Key Distribution Centre (KDC) server Required if state=present \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| pw\_server\_ip string \| \| IP address of the host where the Kerberos password-changing server is running. Typically, this is the same as the host indicated in the adminserver-ip. If this parameter is omitted, the IP address in kdc-ip is used. \| \| pw\_server\_port string \| \| The TCP port on the Kerberos password-changing server where the Kerberos password-changing service is running. The default for this parameter is '464'. \| \| realm string / required \| \| Kerberos realm name \| \| state string \| Choices:* present ← * absent \| Whether the Kerberos realm is present or absent. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| vserver/svm with kerberos realm configured \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create kerberos realm other kdc vendor na_ontap_kerberos_realm: state: present realm: 'EXAMPLE.COM' vserver: 'vserver1' kdc_ip: '1.2.3.4' kdc_vendor: 'other' hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create kerberos realm Microsoft kdc vendor na_ontap_kerberos_realm: state: present realm: 'EXAMPLE.COM' vserver: 'vserver1' kdc_ip: '1.2.3.4' kdc_vendor: 'microsoft' ad_server_ip: '0.0.0.0' ad_server_name: 'server' hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * Milan Zink (@zeten30) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#ceb4abbaaba0fdfee8edfdf9f5e8edfbfcf5e8edfaf6f5a9a3afa7a2e8edfaf8f5ada1a3)>,<[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#432e392a2d28656070747865607671786560777b783126272b22376560777578202c2e)> ansible netapp.ontap.na_ontap_publickey – NetApp ONTAP publickey configuration netapp.ontap.na\_ontap\_publickey – NetApp ONTAP publickey configuration ======================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_publickey`. New in version 21.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add, modify, or remove publickeys. * Requires ONTAP 9.7 or later, and only supports REST. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| account string / required \| \| The name of the user account. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| comment string \| \| Optional comment for the public key. \| \| delete\_all boolean \| Choices:* no ← * yes \| If index is not present, with state=absent, delete all public key for this user account. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| index integer \| \| Index number for the public key. If index is not present, with state=present, the public key is always added, using the next available index. If index is not present, with state=present, the module is not idempotent. If index is not present, with state=absent, if only one key is found, it is deleted. Otherwise an error is reported. See also `delete_all` option. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| public\_key string \| \| The public key. \| \| state string \| Choices:* present ← * absent \| Whether the specified publickey should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string \| \| The name of the vserver to use. Omit this option for cluster scoped user accounts. \| Notes ----- Note * This module supports check\_mode. * This module is not idempotent if index is omitted. * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create publickey netapp.ontap.na_ontap_publickey: state: present account: SampleUser index: 0 public_key: "{{ netapp_publickey }}" vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete single publickey netapp.ontap.na_ontap_publickey: state: absent account: SampleUser vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify single publickey netapp.ontap.na_ontap_publickey: state: present account: SampleUser comment: ssh key for XXXX index: 0 vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cd\_action string \| success \| whether a public key is created or deleted. \| \| modify dictionary \| success \| attributes that were modified if the key already exists. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#6608014b0708150f040a031203070b404555515d404553545d4045525e5d080312071616404552505d05090b)> ansible netapp.ontap.na_ontap_fpolicy_status – NetApp ONTAP - Enables or disables the specified fPolicy policy netapp.ontap.na\_ontap\_fpolicy\_status – NetApp ONTAP - Enables or disables the specified fPolicy policy ========================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fpolicy_status`. New in version 21.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable or disable fPolicy policy. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| policy\_name string / required \| \| Name of the policy. \| \| sequence\_number integer \| \| Policy Sequence Number. \| \| state string \| Choices:* present ← * absent \| Whether the fPolicy policy is enabled or disabled. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to enable fPolicy on. \| Notes ----- Note * Not support check\_mode. * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Enable fPolicy policy na_ontap_fpolicy_status: state: present vserver: svm1 policy_name: fpolicy_policy sequence_number: 10 username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" https: true validate_certs: false - name: Disable fPolicy policy na_ontap_fpolicy_status: state: absent vserver: svm1 policy_name: fpolicy_policy username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" https: true validate_certs: false ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#056b6228646b766c67696071606468232636323e232630373e2326313d3e6b6071647575232631333e666a68)> ansible netapp.ontap.na_ontap_debug – NetApp ONTAP Debug netapp-lib import and connection. netapp.ontap.na\_ontap\_debug – NetApp ONTAP Debug netapp-lib import and connection. ==================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_debug`. New in version 21.1.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Display issues related to importing netapp-lib and connection with diagnose Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string \| \| The vserver name to test for ZAPI tunneling. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Check import netapp-lib na_ontap_debug: hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b9d7de94d8d7cad0dbd5dccddcd8d49f9a8a8e829f9a8c8b829f9a8d8182d7dccdd8c9c99f9a8d8f82dad6d4)>	programming_docs
ansible netapp.ontap.na_ontap_iscsi_security – NetApp ONTAP Manage iscsi security. netapp.ontap.na\_ontap\_iscsi\_security – NetApp ONTAP Manage iscsi security. ============================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_iscsi_security`. New in version 19.10.1: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete/Modify iscsi security. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| address\_ranges list / elements=string \| \| May be a single IPv4 or IPv6 address or a range containing a startaddress and an end address. The start and end addresses themselves are included in the range. If not present, the initiator is allowed to log in from any IP address. \| \| auth\_type string \| Choices:* chap * none * deny \| Specifies the authentication type. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| inbound\_password string \| \| Inbound CHAP user password. Can not be modified. If want to change password, delete and re-create the initiator. \| \| inbound\_username string \| \| Inbound CHAP username. Required for CHAP. A null username is not allowed. \| \| initiator string / required \| \| Specifies the name of the initiator. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| outbound\_password string \| \| Outbound CHAP user password. Can not be modified. If want to change password, delete and re-create the initiator. \| \| outbound\_username string \| \| Outbound CHAP user name. \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified initiator should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create netapp.ontap.na_ontap_iscsi_security: hostname: 0.0.0.0 username: user password: pass vserver: test_svm state: present initiator: eui.9999956789abcdef inbound_username: user_1 inbound_password: password_1 outbound_username: user_2 outbound_password: password_2 auth_type: chap address_ranges: 10.125.10.0-10.125.10.10,10.125.193.78 - name: modify outbound username netapp.ontap.na_ontap_iscsi_security: hostname: 0.0.0.0 username: user password: pass vserver: test_svm state: present initiator: eui.9999956789abcdef inbound_username: user_1 inbound_password: password_1 outbound_username: user_out_3 outbound_password: password_3 auth_type: chap address_ranges: 10.125.10.0-10.125.10.10,10.125.193.78 - name: modify address netapp.ontap.na_ontap_iscsi_security: hostname: 0.0.0.0 username: user password: pass vserver: test_svm state: present initiator: eui.9999956789abcdef address_ranges: 10.125.193.90,10.125.10.20-10.125.10.30 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#6709004a0609140e050b021302060a414454505c414452555c4144535f5c090213061717414453515c04080a)> ansible netapp.ontap.na_ontap_broadcast_domain_ports – NetApp ONTAP manage broadcast domain ports netapp.ontap.na\_ontap\_broadcast\_domain\_ports – NetApp ONTAP manage broadcast domain ports ============================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_broadcast_domain_ports`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add or remove ONTAP broadcast domain ports. Existing ports that are not listed are kept. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| broadcast\_domain string / required \| \| Specify the broadcast\_domain name \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ipspace string \| \| Specify the ipspace for the broadcast domain \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| ports list / elements=string / required \| \| Specify the list of ports to add to or remove from this broadcast domain. \| \| state string \| Choices:* present ← * absent \| Whether the specified broadcast domain should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create broadcast domain ports na_ontap_broadcast_domain_ports: state=present username={{ netapp_username }} password={{ netapp_password }} hostname={{ netapp_hostname }} broadcast_domain=123kevin ports=khutton-vsim1:e0d-13 - name: delete broadcast domain ports na_ontap_broadcast_domain_ports: state=absent username={{ netapp_username }} password={{ netapp_password }} hostname={{ netapp_hostname }} broadcast_domain=123kevin ports=khutton-vsim1:e0d-13 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#553b3278343b263c37393021303438737666626e737660676e7376616d6e3b3021342525737661636e363a38)> ansible netapp.ontap.na_ontap_ports – NetApp ONTAP add/remove ports netapp.ontap.na\_ontap\_ports – NetApp ONTAP add/remove ports ============================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ports`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add or remove ports for broadcast domain and portset. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ipspace string \| \| Specify the required ipspace for the broadcast domain. A domain ipspace can not be modified after the domain has been created. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| names list / elements=string / required \| \| List of ports. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| portset\_type string \| Choices:* fcp * iscsi * mixed \| Protocols accepted for portset. \| \| resource\_name string / required \| \| name of the portset or broadcast domain. \| \| resource\_type string / required \| Choices:* broadcast\_domain * portset \| type of the resource to add a port to or remove a port from. \| \| state string \| Choices:* present ← * absent \| Whether the specified port should be added or removed. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string \| \| Name of the SVM. Specify this option when operating on portset. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: broadcast domain remove port tags: - remove na_ontap_ports: state: absent names: test-vsim1:e0d-1,test-vsim1:e0d-2 resource_type: broadcast_domain resource_name: ansible_domain hostname: "{{ hostname }}" username: user password: password https: False - name: broadcast domain add port tags: - add na_ontap_ports: state: present names: test-vsim1:e0d-1,test-vsim1:e0d-2 resource_type: broadcast_domain resource_name: ansible_domain ipspace: Default hostname: "{{ hostname }}" username: user password: password https: False - name: portset remove port tags: - remove na_ontap_ports: state: absent names: lif_2 resource_type: portset resource_name: portset_1 vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: user password: password https: False - name: portset add port tags: - add na_ontap_ports: state: present names: lif_2 resource_type: portset resource_name: portset_1 portset_type: iscsi vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: user password: password https: False ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1f7178327e716c767d737a6b7a7e72393c2c2824393c2a2d24393c2b2724717a6b7e6f6f393c2b29247c7072)> ansible netapp.ontap.na_ontap_firmware_upgrade – NetApp ONTAP firmware upgrade for SP, shelf, ACP, and disk. netapp.ontap.na\_ontap\_firmware\_upgrade – NetApp ONTAP firmware upgrade for SP, shelf, ACP, and disk. ======================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_firmware_upgrade`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Update ONTAP service-prosessor firmware * The recommend procedure is to 1. download the firmware package from the NetApp Support site 2. copy the package to a web server 3. download the package from the web server using this module * Once a disk qualification, disk, shelf, or ACP firmware package is downloaded, ONTAP will automatically update the related resources in background. * It may take some time to complete. * For service processor, the update requires a node reboot to take effect. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| clear\_logs boolean \| Choices:* no * yes ← \| Clear logs on the device after update. Default value is true. Not used if force\_disruptive\_update is False. \| \| disk\_fw string \| \| disk firmware to be updated to. Not used if force\_disruptive\_update is False (ONTAP will automatically select the firmware) \| \| fail\_on\_502\_error boolean added in 20.6.0 of netapp.ontap \| Choices:* no ← * yes \| The firmware download may take time if the web server is slow and if there are many nodes in the cluster. ONTAP will break the ZAPI connection after 5 minutes with a 502 Bad Gateway error, even though the download is still happening. By default, this module ignores this error and assumes the download is progressing as ONTAP does not provide a way to check the status. When setting this option to true, the module will report 502 as an error. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| firmware\_type string \| Choices:* storage ← * service-processor * shelf * acp * disk \| Type of firmware to be upgraded. Options include shelf, ACP, service-processor, and disk. For shelf firmware upgrade the operation is asynchronous, and therefore returns no errors that might occur during the download process. Shelf firmware upgrade is idempotent if shelf\_module\_fw is provided . disk firmware upgrade is idempotent if disk\_fw is provided . With check mode, SP, ACP, disk, and shelf firmware upgrade is not idempotent. This operation will only update firmware on shelves/disk that do not have the latest firmware-revision. For normal operations, choose one of storage or service-processor. Type storage includes acp, shelf and disk and ONTAP will automatically determine what to do. \| \| force\_disruptive\_update boolean added in 20.4.1 of netapp.ontap \| Choices:* no ← * yes \| If set to `False`, and URL is given, the upgrade is non disruptive. If URL is not given, no operation is performed. Do not set this to `True`, unless directed by NetApp Tech Support. It will force an update even if the resource is not ready for it, and can be disruptive. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| install\_baseline\_image boolean \| Choices:* no ← * yes \| Install the version packaged with ONTAP if this parameter is set to true. Otherwise, package must be used to specify the package to install. Not used if force\_disruptive\_update is False (ONTAP will automatically select the firmware) \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| node string \| \| Node on which the device is located. Not required if package\_url is present and force\_disruptive\_update is False. If this option is not given, the firmware will be downloaded on all nodes in the cluster, and the resources will be updated in background on all nodes, except for service processor. For service processor, the upgrade will happen automatically when each node is rebooted. \| \| ontapi integer \| \| The ontap api version to use \| \| package string \| \| Name of the package file containing the firmware to be installed. Not required when -baseline is true. Not used if force\_disruptive\_update is False. \| \| package\_url string added in 20.4.1 of netapp.ontap \| \| URL of the package file containing the firmware to be downloaded. Once the package file is downloaded to a node, the firmware update will happen automatically in background. For SP, the upgrade will happen automatically when a node is rebooted. For SP, the upgrade will happen automatically if autoupdate is enabled (which is the recommended setting). \| \| password string \| \| Password for the specified user. aliases: pass \| \| reboot\_sp boolean added in 20.6.1 of netapp.ontap \| Choices:* no * yes ← \| Reboot service processor before downloading package. Only available if 'firmware\_type' is 'service-processor'. \| \| rename\_package string added in 20.6.1 of netapp.ontap \| \| Rename the package. Only available if 'firmware\_type' is 'service-processor'. \| \| replace\_package boolean added in 20.6.1 of netapp.ontap \| Choices:* no * yes \| Replace the local package. Only available if 'firmware\_type' is 'service-processor'. \| \| shelf\_module\_fw string \| \| Shelf module firmware to be updated to. Not used if force\_disruptive\_update is False (ONTAP will automatically select the firmware) \| \| state string \| Default:"present" \| Whether the specified ONTAP firmware should be upgraded or not. \| \| update\_type string \| \| Type of firmware update to be performed. Options include serial\_full, serial\_differential, network\_full. Not used if force\_disruptive\_update is False (ONTAP will automatically select the firmware) \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: firmware upgrade na_ontap_firmware_upgrade: state: present package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: firmware upgrade, confirm successful download na_ontap_firmware_upgrade: state: present package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" fail_on_502_error: true - name: SP firmware upgrade na_ontap_firmware_upgrade: state: present node: vsim1 package: "{{ file name }}" package_url: "{{ web_link }}" clear_logs: True install_baseline_image: False update_type: serial_full force_disruptive_update: False firmware_type: service-processor hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: SP firmware download replace package tags: - sp_download na_ontap_firmware_upgrade: state: present node: vsim1 package_url: "{{ web_link }}" firmware_type: service-processor replace_package: true reboot_sp: true hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: true validate_certs: false - name: SP firmware download rename package tags: - sp_download na_ontap_firmware_upgrade: state: present node: vsim1 package_url: "{{ web_link }}" firmware_type: service-processor rename_package: SP_FW.zip hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: true validate_certs: false - name: ACP firmware download and upgrade na_ontap_firmware_upgrade: state: present node: vsim1 firmware_type: acp force_disruptive_update: False package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: shelf firmware upgrade na_ontap_firmware_upgrade: state: present firmware_type: shelf shelf_module_fw: 1221 force_disruptive_update: False package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: disk firmware upgrade na_ontap_firmware_upgrade: state: present firmware_type: disk disk_fw: NA02 force_disruptive_update: False package_url: "{{ web_link }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| always \| Returns additional information in case of success. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#4a242d672b24392328262f3e2f2b276c69797d716c697f78716c697e7271242f3e2b3a3a6c697e7c71292527)>	programming_docs
ansible netapp.ontap.na_ontap_cg_snapshot – NetApp ONTAP manage consistency group snapshot netapp.ontap.na\_ontap\_cg\_snapshot – NetApp ONTAP manage consistency group snapshot ===================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cg_snapshot`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create consistency group snapshot for ONTAP volumes. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| snapmirror\_label string \| \| A human readable SnapMirror label to be attached with the consistency group snapshot copies. \| \| snapshot string / required \| \| The provided name of the snapshot that is created in each volume. \| \| state string \| Default:"present" \| If you want to create a snapshot. \| \| timeout string \| Choices:* urgent * medium ← * relaxed \| Timeout selector. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volumes list / elements=string / required \| \| A list of volumes in this filer that is part of this CG operation. \| \| vserver string / required \| \| Name of the vserver. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: na_ontap_cg_snapshot: state: present vserver: vserver_name snapshot: snapshot name volumes: vol_name username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#dfb1b8f2beb1acb6bdb3baabbabeb2f9fcece8e4f9fceaede4f9fcebe7e4b1baabbeafaff9fcebe9e4bcb0b2)> ansible netapp.ontap.na_ontap_snmp – NetApp ONTAP SNMP community netapp.ontap.na\_ontap\_snmp – NetApp ONTAP SNMP community ========================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_snmp`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete SNMP community Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| access\_control string \| Choices:* ro ← \| Access control for the community. The only supported value is 'ro' (read-only). Ignored with REST \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| community\_name string / required \| \| The name of the SNMP community to manage. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified SNMP community should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create SNMP community (ZAPI only) netapp.ontap.na_ontap_snmp: state: present community_name: communityName access_control: 'ro' use_rest: never hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create SNMP community (snmpv1 or snmpv2) (REST only) netapp.ontap.na_ontap_snmp: state: present community_name: communityName use_rest: always hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete SNMP community (ZAPI only) netapp.ontap.na_ontap_snmp: state: absent community_name: communityName access_control: 'ro' use_rest: never hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete SNMP community (snmpv1 or snmpv2) (REST only) netapp.ontap.na_ontap_snmp: state: absent community_name: communityName use_rest: always hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#84eae3a9e5eaf7ede6e8e1f0e1e5e9a2a7b7b3bfa2a7b1b6bfa2a7b0bcbfeae1f0e5f4f4a2a7b0b2bfe7ebe9)> ansible netapp.ontap.na_ontap_ucadapter – NetApp ONTAP UC adapter configuration netapp.ontap.na\_ontap\_ucadapter – NetApp ONTAP UC adapter configuration ========================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ucadapter`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * modify the UC adapter mode and type taking pending type and mode into account. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| adapter\_name string / required \| \| Specifies the adapter name. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| mode string \| \| Specifies the mode of the adapter. \| \| node\_name string / required \| \| Specifies the adapter home node. \| \| ontapi integer \| \| The ontap api version to use \| \| pair\_adapters list / elements=string added in 20.6.0 of netapp.ontap \| \| Specifies the list of adapters which also need to be offline along with the current adapter during modifying. If specified adapter works in a group or pair, the other adapters might also need to offline before modify the specified adapter. The mode of pair\_adapters are modified along with the adapter, the type of the pair\_adapters are not modified. \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← \| Whether the specified adapter should exist. \| \| type string \| \| Specifies the fc4 type of the adapter. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Modify adapter na_ontap_adapter: state: present adapter_name: 0e pair_adapters: 0f node_name: laurentn-vsim1 mode: fc type: target hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#bbd5dc96dad5c8d2d9d7decfdedad69d98888c809d988e89809d988f8380d5decfdacbcb9d988f8d80d8d4d6)> ansible netapp.ontap.na_ontap_wwpn_alias – NetApp ONTAP set FCP WWPN Alias netapp.ontap.na\_ontap\_wwpn\_alias – NetApp ONTAP set FCP WWPN Alias ===================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_wwpn_alias`. New in version 20.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete FCP WWPN Alias Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the alias to create or delete. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified alias should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| \| wwpn string \| \| WWPN of the alias. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create FCP Alias na_ontap_wwpn_alias: state: present name: alias1 wwpn: 01:02:03:04:0a:0b:0c:0d vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete FCP Alias na_ontap_wwpn_alias: state: absent name: alias1 vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#99f7feb4f8f7eaf0fbf5fcedfcf8f4bfbaaaaea2bfbaacaba2bfbaada1a2f7fcedf8e9e9bfbaadafa2faf6f4)>	programming_docs
ansible netapp.ontap.na_ontap_log_forward – NetApp ONTAP Log Forward Configuration netapp.ontap.na\_ontap\_log\_forward – NetApp ONTAP Log Forward Configuration ============================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_log_forward`. New in version 21.2.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete or modify the log forward configuration Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| destination string / required \| \| Destination address that the log messages will be forwarded to. Can be a hostname or IP address. \| \| facility string \| Choices:* kern * user * local0 * local1 * local2 * local3 * local4 * local5 * local6 * local7 \| Facility code used to indicate the type of software that generated the message. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force boolean \| Choices:* no * yes \| Skip the Connectivity Test \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| port integer / required \| \| The destination port used to forward the message. \| \| protocol string \| Choices:* udp\_unencrypted * tcp\_unencrypted * tcp\_encrypted \| Log Forwarding Protocol \| \| state string \| Choices:* present ← * absent \| Whether the log forward configuration should exist or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| verify\_server boolean \| Choices:* no * yes \| Verify Destination Server Identity \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create log forward configuration na_ontap_log_forward: state: present destination: 10.11.12.13 port: 514 protocol: udp_unencrypted username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: Modify log forward configuration na_ontap_log_forward: state: present destination: 10.11.12.13 port: 514 protocol: tcp_unencrypted username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: Delete log forward configuration na_ontap_log_forward: state: absent destination: 10.11.12.13 port: 514 username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#92fcf5bff3fce1fbf0fef7e6f7f3ffb4b1a1a5a9b4b1a7a0a9b4b1a6aaa9fcf7e6f3e2e2b4b1a6a4a9f1fdff)> ansible netapp.ontap.na_ontap_cifs_local_group_member – NetApp Ontap - Add or remove CIFS local group member netapp.ontap.na\_ontap\_cifs\_local\_group\_member – NetApp Ontap - Add or remove CIFS local group member ========================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cifs_local_group_member`. New in version 21.2.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add or remove CIFS local group member Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| group string / required \| \| Specifies name of the CIFS local group \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| member string / required \| \| Specifies the name of the member \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified member should be part of the CIFS local group \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver that owns the CIFS local group \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Add member to CIFS local group na_ontap_cifs_local_group_member: state: present vserver: svm1 group: BUILTIN\administrators member: DOMAIN\Domain Admins hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ontapi: "{{ ontap_facts.ontap_version }}" https: true validate_certs: false - name: Remove member from CIFS local group na_ontap_cifs_local_group_member: state: absent vserver: svm1 group: BUILTIN\administrators member: DOMAIN\Domain Admins hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ontapi: "{{ ontap_facts.ontap_version }}" https: true validate_certs: false ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#9df3fab0fcf3eef4fff1f8e9f8fcf0bbbeaeaaa6bbbea8afa6bbbea9a5a6f3f8e9fcededbbbea9aba6fef2f0)> ansible netapp.ontap.na_ontap_partitions – NetApp ONTAP Assign partitions and disks to nodes. netapp.ontap.na\_ontap\_partitions – NetApp ONTAP Assign partitions and disks to nodes. ======================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_partitions`. New in version 21.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Assign the specified number of partitions or disks eligible for partitioning to a node. * There is some overlap between this module and the na\_ontap\_disks module. * If you don’t have ADP v1 or v2 then you should be using the na\_ontap\_disks module to assign whole disks. * Partitions/disks are added in the following order * 1. Any unassigned partitions are added. * 2. Any unassigned disks of the correct type are added and will be partitioned when added to an aggregate if required. * 3. Any spare partner partitions will be re-assigned. * 4. Any partner spare disks will be re-assigned and be partitioned when added to an aggregate. * If you specify a partition\_count less than the current number of partitions, then spare partitions will be unassigned. * If a previously partitioned disk has the partitions removed, and even if it is “slow zeroed” the system will consider it a shared partitioned disk rather than a spare. * In a root-data-data configuration (ADPv2) if you specify data1 as the partition\_type then only P1 partitions will be counted. * Disk autoassign must be turned off before using this module to prevent the disks being reassigned automatically by the cluster. * This can be done through na\_ontap\_disk\_options or via the cli “disk option modify -node <node\_name> -autoassign off”. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| disk\_type string / required \| Choices:* ATA * BSAS * FCAL * FSAS * LUN * MSATA * SAS * SSD * SSD\_NVM * VMDISK * unknown \| The type of disk that the partitions that should use. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| min\_spares integer \| \| Minimum spares disks or partitions required per type for the node. \| \| node string / required \| \| Specifies the node that the partitions and disks should be assigned to. \| \| ontapi integer \| \| The ontap api version to use \| \| partition\_count integer / required \| \| Total number of partitions that should be assigned to the owner. \| \| partition\_type string / required \| Choices:* data * root * data1 * data2 \| The type of partiton being assigned either root, data, data1 or data2, \| \| partitioning\_method string / required \| Choices:* root\_data * root\_data1\_data2 \| The type of partiton method being used, either root\_data or root\_data1\_data2. \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Assign specified total partitions to node cluster-01 na_ontap_disk_partitions_custom: node: cluster-01 partition_count: 56 disk_type: FSAS partition_type: data hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f39d94de929d809a919f968796929ed5d0c0c4c8d5d0c6c1c8d5d0c7cbc89d9687928383d5d0c7c5c8909c9e)> ansible netapp.ontap.na_ontap_login_messages – Setup login banner and message of the day netapp.ontap.na\_ontap\_login\_messages – Setup login banner and message of the day =================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_login_messages`. New in version 20.1.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * This module allows you to manipulate login banner and motd for a vserver Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| banner string \| \| Login banner Text message. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| motd\_message string \| \| MOTD Text message. aliases: message \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| show\_cluster\_motd boolean \| Choices:* no * yes ← \| Set to false if Cluster-level Message of the Day should not be shown \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the SVM login messages should be set for. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: modify banner vserver na_ontap_login_messages: vserver: trident_svm banner: this is trident vserver usename: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: modify motd vserver na_ontap_login_messages: vserver: trident_svm motd_message: this is trident vserver show_cluster_motd: True usename: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#543a3379353a273d36383120313539727767636f727761666f7277606c6f3a3120352424727760626f373b39)>	programming_docs
ansible netapp.ontap.na_ontap_net_subnet – NetApp ONTAP Create, delete, modify network subnets. netapp.ontap.na\_ontap\_net\_subnet – NetApp ONTAP Create, delete, modify network subnets. ========================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_net_subnet`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify, destroy the network subnet Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| broadcast\_domain string \| \| Specify the required broadcast\_domain name for the subnet. A broadcast domain can not be modified after the subnet has been created \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string \| \| Name of the subnet to be renamed \| \| gateway string \| \| Specify the gateway for the default route of the subnet. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ip\_ranges list / elements=string \| \| Specify the list of IP address ranges associated with the subnet. \| \| ipspace string \| \| Specify the ipspace for the subnet. The default value for this parameter is the default IPspace, named 'Default'. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specify the subnet name. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified network interface group should exist or not. \| \| subnet string \| \| Specify the subnet (ip and mask). \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create subnet na_ontap_net_subnet: state: present username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" subnet: 10.10.10.0/24 name: subnet-adm ip_ranges: [ '10.10.10.30-10.10.10.40', '10.10.10.51' ] gateway: 10.10.10.254 ipspace: Default broadcast_domain: Default - name: delete subnet na_ontap_net_subnet: state: absent username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" name: subnet-adm ipspace: Default - name: rename subnet na_ontap_net_subnet: state: present username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" name: subnet-adm-new from_name: subnet-adm ipspace: Default ``` ### Authors * Storage Engineering (@Albinpopote) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#fe9f908d979c929bd8ddcdc9c5d8ddcbccc5d8ddcac6c59c929f9d95d38e9b8c92d8ddcac8c5988c)> ansible netapp.ontap.na_ontap_dns – NetApp ONTAP Create, delete, modify DNS servers. netapp.ontap.na\_ontap\_dns – NetApp ONTAP Create, delete, modify DNS servers. ============================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_dns`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete, modify DNS servers. * With REST, the module is currently limited to data vservers for delete or modify operations. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| domains list / elements=string \| \| List of DNS domains such as 'sales.bar.com'. The first domain is the one that the Vserver belongs to. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| nameservers list / elements=string \| \| List of IPv4 addresses of name servers such as '123.123.123.123'. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| skip\_validation boolean added in 2.8.0 of netapp.ontap \| Choices:* no * yes \| By default, all nameservers are checked to validate they are available to resolve. If you DNS servers are not yet installed or momentarily not available, you can set this option to 'true' to bypass the check for all servers specified in nameservers field. \| \| state string \| Choices:* present ← * absent \| Whether the DNS servers should be enabled for the given vserver. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create DNS na_ontap_dns: state: present hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" vserver: "{{vservername}}" domains: sales.bar.com nameservers: 10.193.0.250,10.192.0.250 skip_validation: true ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#bad4dd97dbd4c9d3d8d6dfcedfdbd79c99898d819c998f88819c998e8281d4dfcedbcaca9c998e8c81d9d5d7)> ansible netapp.ontap.na_ontap_license – NetApp ONTAP protocol and feature licenses netapp.ontap.na\_ontap\_license – NetApp ONTAP protocol and feature licenses ============================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_license`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add or remove licenses on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| license\_codes list / elements=string \| \| List of license codes to be added. \| \| license\_names list / elements=string \| \| List of license-names to delete. \| \| \| base string \| \| Cluster Base License \| \| \| cdmi string \| \| CDMI License \| \| \| cifs string \| \| CIFS License \| \| \| fcp string \| \| FCP License \| \| \| flexclone string \| \| FlexClone License \| \| \| iscsi string \| \| iSCSI License \| \| \| nfs string \| \| NFS License \| \| \| snaplock string \| \| SnapLock License \| \| \| snapmanagersuite string \| \| SnapManagerSuite License \| \| \| snapmirror string \| \| SnapMirror License \| \| \| snapprotectapps string \| \| SnapProtectApp License \| \| \| snaprestore string \| \| SnapRestore License \| \| \| snapvault string \| \| SnapVault License \| \| \| v\_storageattach string \| \| Virtual Attached Storage License \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| remove\_expired boolean \| Choices:* no * yes \| Remove licenses that have expired in the cluster. \| \| remove\_unused boolean \| Choices:* no * yes \| Remove licenses that have no controller affiliation in the cluster. \| \| serial\_number string \| \| Serial number of the node associated with the license. This parameter is used primarily when removing license for a specific service. \| \| state string \| Choices:* present ← * absent \| Whether the specified license should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Add licenses na_ontap_license: state: present hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" serial_number: ################# license_codes: CODE1,CODE2 - name: Remove licenses na_ontap_license: state: absent hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" remove_unused: false remove_expired: true serial_number: ################# license_names: nfs,cifs ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#147a7339757a677d76787160717579323727232f323721262f3237202c2f7a7160756464323720222f777b79)> ansible netapp.ontap.na_ontap_qtree – NetApp ONTAP manage qtrees netapp.ontap.na\_ontap\_qtree – NetApp ONTAP manage qtrees ========================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_qtree`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or destroy Qtrees. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| export\_policy string added in 2.9.0 of netapp.ontap \| \| The name of the export policy to apply. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| flexvol\_name string / required \| \| The name of the FlexVol the qtree should exist on. \| \| force\_delete boolean added in 20.8.0 of netapp.ontap \| Choices:* no * yes ← \| Whether the qtree should be deleted even if files still exist. Note that the default of true reflect the REST API behavior. a value of false is not supported with REST. \| \| from\_name string added in 2.7.0 of netapp.ontap \| \| Name of the qtree to be renamed. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the qtree to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| oplocks string added in 2.9.0 of netapp.ontap \| Choices:* enabled * disabled \| Whether the oplocks should be enabled or not for the qtree. \| \| password string \| \| Password for the specified user. aliases: pass \| \| security\_style string added in 2.9.0 of netapp.ontap \| Choices:* unix * ntfs * mixed \| The security style for the qtree. \| \| state string \| Choices:* present ← * absent \| Whether the specified qtree should exist or not. \| \| time\_out integer added in 2.9.0 of netapp.ontap \| Default:180 \| Maximum time to wait for qtree deletion in seconds when wait\_for\_completion is True. Error out if task is not completed in defined time. Default is set to 3 minutes. \| \| unix\_permissions string added in 2.9.0 of netapp.ontap \| \| File permissions bits of the qtree. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| \| wait\_for\_completion boolean added in 2.9.0 of netapp.ontap \| Choices:* no * yes ← \| Only applicable for REST. When using ZAPI, the deletion is always synchronous. Deleting a qtree may take time if many files need to be deleted. Set this parameter to 'true' for synchronous execution during delete. Set this parameter to 'false' for asynchronous execution. For asynchronous, execution exits as soon as the request is sent, and the qtree is deleted in background. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create Qtrees na_ontap_qtree: state: present name: ansibleQTree flexvol_name: ansibleVolume export_policy: policyName security_style: mixed oplocks: disabled unix_permissions: vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Rename Qtrees na_ontap_qtree: state: present from_name: ansibleQTree_rename name: ansibleQTree flexvol_name: ansibleVolume vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#ec828bc18d829f858e808998898d81cacfdfdbd7cacfd9ded7cacfd8d4d78289988d9c9ccacfd8dad78f8381)>	programming_docs
ansible Netapp.Ontap Netapp.Ontap ============ Collection version 21.12.0 Plugin Index ------------ These are the plugins in the netapp.ontap collection ### Modules * [na\_ontap\_active\_directory](na_ontap_active_directory_module#ansible-collections-netapp-ontap-na-ontap-active-directory-module) – NetApp ONTAP configure active directory * [na\_ontap\_aggregate](na_ontap_aggregate_module#ansible-collections-netapp-ontap-na-ontap-aggregate-module) – NetApp ONTAP manage aggregates. * [na\_ontap\_autosupport](na_ontap_autosupport_module#ansible-collections-netapp-ontap-na-ontap-autosupport-module) – NetApp ONTAP autosupport * [na\_ontap\_autosupport\_invoke](na_ontap_autosupport_invoke_module#ansible-collections-netapp-ontap-na-ontap-autosupport-invoke-module) – NetApp ONTAP send AutoSupport message * [na\_ontap\_broadcast\_domain](na_ontap_broadcast_domain_module#ansible-collections-netapp-ontap-na-ontap-broadcast-domain-module) – NetApp ONTAP manage broadcast domains. * [na\_ontap\_broadcast\_domain\_ports](na_ontap_broadcast_domain_ports_module#ansible-collections-netapp-ontap-na-ontap-broadcast-domain-ports-module) – NetApp ONTAP manage broadcast domain ports * [na\_ontap\_cg\_snapshot](na_ontap_cg_snapshot_module#ansible-collections-netapp-ontap-na-ontap-cg-snapshot-module) – NetApp ONTAP manage consistency group snapshot * [na\_ontap\_cifs](na_ontap_cifs_module#ansible-collections-netapp-ontap-na-ontap-cifs-module) – NetApp ONTAP Manage cifs-share * [na\_ontap\_cifs\_acl](na_ontap_cifs_acl_module#ansible-collections-netapp-ontap-na-ontap-cifs-acl-module) – NetApp ONTAP manage cifs-share-access-control * [na\_ontap\_cifs\_local\_group\_member](na_ontap_cifs_local_group_member_module#ansible-collections-netapp-ontap-na-ontap-cifs-local-group-member-module) – NetApp Ontap - Add or remove CIFS local group member * [na\_ontap\_cifs\_local\_user\_modify](na_ontap_cifs_local_user_modify_module#ansible-collections-netapp-ontap-na-ontap-cifs-local-user-modify-module) – NetApp ONTAP modify local CIFS user. * [na\_ontap\_cifs\_local\_user\_set\_password](na_ontap_cifs_local_user_set_password_module#ansible-collections-netapp-ontap-na-ontap-cifs-local-user-set-password-module) – NetApp ONTAP set local CIFS user password * [na\_ontap\_cifs\_server](na_ontap_cifs_server_module#ansible-collections-netapp-ontap-na-ontap-cifs-server-module) – NetApp ONTAP CIFS server configuration * [na\_ontap\_cluster](na_ontap_cluster_module#ansible-collections-netapp-ontap-na-ontap-cluster-module) – NetApp ONTAP cluster - create a cluster and add/remove nodes. * [na\_ontap\_cluster\_ha](na_ontap_cluster_ha_module#ansible-collections-netapp-ontap-na-ontap-cluster-ha-module) – NetApp ONTAP Manage HA status for cluster * [na\_ontap\_cluster\_peer](na_ontap_cluster_peer_module#ansible-collections-netapp-ontap-na-ontap-cluster-peer-module) – NetApp ONTAP Manage Cluster peering * [na\_ontap\_command](na_ontap_command_module#ansible-collections-netapp-ontap-na-ontap-command-module) – NetApp ONTAP Run any cli command, the username provided needs to have console login permission. * [na\_ontap\_debug](na_ontap_debug_module#ansible-collections-netapp-ontap-na-ontap-debug-module) – NetApp ONTAP Debug netapp-lib import and connection. * [na\_ontap\_disk\_options](na_ontap_disk_options_module#ansible-collections-netapp-ontap-na-ontap-disk-options-module) – NetApp ONTAP modify storage disk options * [na\_ontap\_disks](na_ontap_disks_module#ansible-collections-netapp-ontap-na-ontap-disks-module) – NetApp ONTAP Assign disks to nodes * [na\_ontap\_dns](na_ontap_dns_module#ansible-collections-netapp-ontap-na-ontap-dns-module) – NetApp ONTAP Create, delete, modify DNS servers. * [na\_ontap\_domain\_tunnel](na_ontap_domain_tunnel_module#ansible-collections-netapp-ontap-na-ontap-domain-tunnel-module) – NetApp ONTAP domain tunnel * [na\_ontap\_efficiency\_policy](na_ontap_efficiency_policy_module#ansible-collections-netapp-ontap-na-ontap-efficiency-policy-module) – NetApp ONTAP manage efficiency policies (sis policies) * [na\_ontap\_export\_policy](na_ontap_export_policy_module#ansible-collections-netapp-ontap-na-ontap-export-policy-module) – NetApp ONTAP manage export-policy * [na\_ontap\_export\_policy\_rule](na_ontap_export_policy_rule_module#ansible-collections-netapp-ontap-na-ontap-export-policy-rule-module) – NetApp ONTAP manage export policy rules * [na\_ontap\_fcp](na_ontap_fcp_module#ansible-collections-netapp-ontap-na-ontap-fcp-module) – NetApp ONTAP Start, Stop and Enable FCP services. * [na\_ontap\_fdsd](na_ontap_fdsd_module#ansible-collections-netapp-ontap-na-ontap-fdsd-module) – NetApp ONTAP create or remove a File Directory security descriptor. * [na\_ontap\_fdsp](na_ontap_fdsp_module#ansible-collections-netapp-ontap-na-ontap-fdsp-module) – NetApp ONTAP create or delete a file directory security policy * [na\_ontap\_fdspt](na_ontap_fdspt_module#ansible-collections-netapp-ontap-na-ontap-fdspt-module) – NetApp ONTAP create, delete or modify File Directory security policy tasks * [na\_ontap\_fdss](na_ontap_fdss_module#ansible-collections-netapp-ontap-na-ontap-fdss-module) – NetApp ONTAP File Directory Security Set. * [na\_ontap\_file\_directory\_policy](na_ontap_file_directory_policy_module#ansible-collections-netapp-ontap-na-ontap-file-directory-policy-module) – NetApp ONTAP create, delete, or modify vserver security file-directory policy * [na\_ontap\_firewall\_policy](na_ontap_firewall_policy_module#ansible-collections-netapp-ontap-na-ontap-firewall-policy-module) – NetApp ONTAP Manage a firewall policy * [na\_ontap\_firmware\_upgrade](na_ontap_firmware_upgrade_module#ansible-collections-netapp-ontap-na-ontap-firmware-upgrade-module) – NetApp ONTAP firmware upgrade for SP, shelf, ACP, and disk. * [na\_ontap\_flexcache](na_ontap_flexcache_module#ansible-collections-netapp-ontap-na-ontap-flexcache-module) – NetApp ONTAP FlexCache - create/delete relationship * [na\_ontap\_fpolicy\_event](na_ontap_fpolicy_event_module#ansible-collections-netapp-ontap-na-ontap-fpolicy-event-module) – NetApp ONTAP FPolicy policy event configuration * [na\_ontap\_fpolicy\_ext\_engine](na_ontap_fpolicy_ext_engine_module#ansible-collections-netapp-ontap-na-ontap-fpolicy-ext-engine-module) – NetApp ONTAP fPolicy external engine configuration. * [na\_ontap\_fpolicy\_policy](na_ontap_fpolicy_policy_module#ansible-collections-netapp-ontap-na-ontap-fpolicy-policy-module) – NetApp ONTAP - Create, delete or modify an FPolicy policy. * [na\_ontap\_fpolicy\_scope](na_ontap_fpolicy_scope_module#ansible-collections-netapp-ontap-na-ontap-fpolicy-scope-module) – NetApp ONTAP - Create, delete or modify an FPolicy policy scope configuration. * [na\_ontap\_fpolicy\_status](na_ontap_fpolicy_status_module#ansible-collections-netapp-ontap-na-ontap-fpolicy-status-module) – NetApp ONTAP - Enables or disables the specified fPolicy policy * [na\_ontap\_igroup](na_ontap_igroup_module#ansible-collections-netapp-ontap-na-ontap-igroup-module) – NetApp ONTAP iSCSI or FC igroup configuration * [na\_ontap\_igroup\_initiator](na_ontap_igroup_initiator_module#ansible-collections-netapp-ontap-na-ontap-igroup-initiator-module) – NetApp ONTAP igroup initiator configuration * [na\_ontap\_info](na_ontap_info_module#ansible-collections-netapp-ontap-na-ontap-info-module) – NetApp information gatherer * [na\_ontap\_interface](na_ontap_interface_module#ansible-collections-netapp-ontap-na-ontap-interface-module) – NetApp ONTAP LIF configuration * [na\_ontap\_ipspace](na_ontap_ipspace_module#ansible-collections-netapp-ontap-na-ontap-ipspace-module) – NetApp ONTAP Manage an ipspace * [na\_ontap\_iscsi](na_ontap_iscsi_module#ansible-collections-netapp-ontap-na-ontap-iscsi-module) – NetApp ONTAP manage iSCSI service * [na\_ontap\_iscsi\_security](na_ontap_iscsi_security_module#ansible-collections-netapp-ontap-na-ontap-iscsi-security-module) – NetApp ONTAP Manage iscsi security. * [na\_ontap\_job\_schedule](na_ontap_job_schedule_module#ansible-collections-netapp-ontap-na-ontap-job-schedule-module) – NetApp ONTAP Job Schedule * [na\_ontap\_kerberos\_realm](na_ontap_kerberos_realm_module#ansible-collections-netapp-ontap-na-ontap-kerberos-realm-module) – NetApp ONTAP vserver nfs kerberos realm * [na\_ontap\_ldap](na_ontap_ldap_module#ansible-collections-netapp-ontap-na-ontap-ldap-module) – NetApp ONTAP LDAP * [na\_ontap\_ldap\_client](na_ontap_ldap_client_module#ansible-collections-netapp-ontap-na-ontap-ldap-client-module) – NetApp ONTAP LDAP client * [na\_ontap\_license](na_ontap_license_module#ansible-collections-netapp-ontap-na-ontap-license-module) – NetApp ONTAP protocol and feature licenses * [na\_ontap\_log\_forward](na_ontap_log_forward_module#ansible-collections-netapp-ontap-na-ontap-log-forward-module) – NetApp ONTAP Log Forward Configuration * [na\_ontap\_login\_messages](na_ontap_login_messages_module#ansible-collections-netapp-ontap-na-ontap-login-messages-module) – Setup login banner and message of the day * [na\_ontap\_lun](na_ontap_lun_module#ansible-collections-netapp-ontap-na-ontap-lun-module) – NetApp ONTAP manage LUNs * [na\_ontap\_lun\_copy](na_ontap_lun_copy_module#ansible-collections-netapp-ontap-na-ontap-lun-copy-module) – NetApp ONTAP copy LUNs * [na\_ontap\_lun\_map](na_ontap_lun_map_module#ansible-collections-netapp-ontap-na-ontap-lun-map-module) – NetApp ONTAP LUN maps * [na\_ontap\_lun\_map\_reporting\_nodes](na_ontap_lun_map_reporting_nodes_module#ansible-collections-netapp-ontap-na-ontap-lun-map-reporting-nodes-module) – NetApp ONTAP LUN maps reporting nodes * [na\_ontap\_mcc\_mediator](na_ontap_mcc_mediator_module#ansible-collections-netapp-ontap-na-ontap-mcc-mediator-module) – NetApp ONTAP Add and Remove MetroCluster Mediator * [na\_ontap\_metrocluster](na_ontap_metrocluster_module#ansible-collections-netapp-ontap-na-ontap-metrocluster-module) – NetApp ONTAP set up a MetroCluster * [na\_ontap\_metrocluster\_dr\_group](na_ontap_metrocluster_dr_group_module#ansible-collections-netapp-ontap-na-ontap-metrocluster-dr-group-module) – NetApp ONTAP manage MetroCluster DR Group * [na\_ontap\_motd](na_ontap_motd_module#ansible-collections-netapp-ontap-na-ontap-motd-module) – Setup motd * [na\_ontap\_name\_service\_switch](na_ontap_name_service_switch_module#ansible-collections-netapp-ontap-na-ontap-name-service-switch-module) – NetApp ONTAP Manage name service switch * [na\_ontap\_ndmp](na_ontap_ndmp_module#ansible-collections-netapp-ontap-na-ontap-ndmp-module) – NetApp ONTAP NDMP services configuration * [na\_ontap\_net\_ifgrp](na_ontap_net_ifgrp_module#ansible-collections-netapp-ontap-na-ontap-net-ifgrp-module) – NetApp Ontap modify network interface group * [na\_ontap\_net\_port](na_ontap_net_port_module#ansible-collections-netapp-ontap-na-ontap-net-port-module) – NetApp ONTAP network ports. * [na\_ontap\_net\_routes](na_ontap_net_routes_module#ansible-collections-netapp-ontap-na-ontap-net-routes-module) – NetApp ONTAP network routes * [na\_ontap\_net\_subnet](na_ontap_net_subnet_module#ansible-collections-netapp-ontap-na-ontap-net-subnet-module) – NetApp ONTAP Create, delete, modify network subnets. * [na\_ontap\_net\_vlan](na_ontap_net_vlan_module#ansible-collections-netapp-ontap-na-ontap-net-vlan-module) – NetApp ONTAP network VLAN * [na\_ontap\_nfs](na_ontap_nfs_module#ansible-collections-netapp-ontap-na-ontap-nfs-module) – NetApp ONTAP NFS status * [na\_ontap\_node](na_ontap_node_module#ansible-collections-netapp-ontap-na-ontap-node-module) – NetApp ONTAP Modify or Rename a node. * [na\_ontap\_ntfs\_dacl](na_ontap_ntfs_dacl_module#ansible-collections-netapp-ontap-na-ontap-ntfs-dacl-module) – NetApp Ontap create, delate or modify NTFS DACL (discretionary access control list) * [na\_ontap\_ntfs\_sd](na_ontap_ntfs_sd_module#ansible-collections-netapp-ontap-na-ontap-ntfs-sd-module) – NetApp ONTAP create, delete or modify NTFS security descriptor * [na\_ontap\_ntp](na_ontap_ntp_module#ansible-collections-netapp-ontap-na-ontap-ntp-module) – NetApp ONTAP NTP server * [na\_ontap\_nvme](na_ontap_nvme_module#ansible-collections-netapp-ontap-na-ontap-nvme-module) – NetApp ONTAP Manage NVMe Service * [na\_ontap\_nvme\_namespace](na_ontap_nvme_namespace_module#ansible-collections-netapp-ontap-na-ontap-nvme-namespace-module) – NetApp ONTAP Manage NVME Namespace * [na\_ontap\_nvme\_subsystem](na_ontap_nvme_subsystem_module#ansible-collections-netapp-ontap-na-ontap-nvme-subsystem-module) – NetApp ONTAP Manage NVME Subsystem * [na\_ontap\_object\_store](na_ontap_object_store_module#ansible-collections-netapp-ontap-na-ontap-object-store-module) – NetApp ONTAP manage object store config. * [na\_ontap\_partitions](na_ontap_partitions_module#ansible-collections-netapp-ontap-na-ontap-partitions-module) – NetApp ONTAP Assign partitions and disks to nodes. * [na\_ontap\_ports](na_ontap_ports_module#ansible-collections-netapp-ontap-na-ontap-ports-module) – NetApp ONTAP add/remove ports * [na\_ontap\_portset](na_ontap_portset_module#ansible-collections-netapp-ontap-na-ontap-portset-module) – NetApp ONTAP Create/Delete portset * [na\_ontap\_publickey](na_ontap_publickey_module#ansible-collections-netapp-ontap-na-ontap-publickey-module) – NetApp ONTAP publickey configuration * [na\_ontap\_qos\_adaptive\_policy\_group](na_ontap_qos_adaptive_policy_group_module#ansible-collections-netapp-ontap-na-ontap-qos-adaptive-policy-group-module) – NetApp ONTAP Adaptive Quality of Service policy group. * [na\_ontap\_qos\_policy\_group](na_ontap_qos_policy_group_module#ansible-collections-netapp-ontap-na-ontap-qos-policy-group-module) – NetApp ONTAP manage policy group in Quality of Service. * [na\_ontap\_qtree](na_ontap_qtree_module#ansible-collections-netapp-ontap-na-ontap-qtree-module) – NetApp ONTAP manage qtrees * [na\_ontap\_quota\_policy](na_ontap_quota_policy_module#ansible-collections-netapp-ontap-na-ontap-quota-policy-module) – NetApp Ontap create, assign, rename or delete quota policy * [na\_ontap\_quotas](na_ontap_quotas_module#ansible-collections-netapp-ontap-na-ontap-quotas-module) – NetApp ONTAP Quotas * [na\_ontap\_rest\_cli](na_ontap_rest_cli_module#ansible-collections-netapp-ontap-na-ontap-rest-cli-module) – NetApp ONTAP run any CLI command using REST api/private/cli/ * [na\_ontap\_rest\_info](na_ontap_rest_info_module#ansible-collections-netapp-ontap-na-ontap-rest-info-module) – NetApp ONTAP information gatherer using REST APIs * [na\_ontap\_restit](na_ontap_restit_module#ansible-collections-netapp-ontap-na-ontap-restit-module) – NetApp ONTAP Run any REST API on ONTAP * [na\_ontap\_security\_certificates](na_ontap_security_certificates_module#ansible-collections-netapp-ontap-na-ontap-security-certificates-module) – NetApp ONTAP manage security certificates. * [na\_ontap\_security\_config](na_ontap_security_config_module#ansible-collections-netapp-ontap-na-ontap-security-config-module) – NetApp ONTAP modify security config for SSL. * [na\_ontap\_security\_key\_manager](na_ontap_security_key_manager_module#ansible-collections-netapp-ontap-na-ontap-security-key-manager-module) – NetApp ONTAP security key manager. * [na\_ontap\_service\_policy](na_ontap_service_policy_module#ansible-collections-netapp-ontap-na-ontap-service-policy-module) – NetApp ONTAP service policy configuration * [na\_ontap\_service\_processor\_network](na_ontap_service_processor_network_module#ansible-collections-netapp-ontap-na-ontap-service-processor-network-module) – NetApp ONTAP service processor network * [na\_ontap\_snaplock\_clock](na_ontap_snaplock_clock_module#ansible-collections-netapp-ontap-na-ontap-snaplock-clock-module) – NetApp ONTAP Sets the snaplock compliance clock. * [na\_ontap\_snapmirror](na_ontap_snapmirror_module#ansible-collections-netapp-ontap-na-ontap-snapmirror-module) – NetApp ONTAP or ElementSW Manage SnapMirror * [na\_ontap\_snapmirror\_policy](na_ontap_snapmirror_policy_module#ansible-collections-netapp-ontap-na-ontap-snapmirror-policy-module) – NetApp ONTAP create, delete or modify SnapMirror policies * [na\_ontap\_snapshot](na_ontap_snapshot_module#ansible-collections-netapp-ontap-na-ontap-snapshot-module) – NetApp ONTAP manage Snapshots * [na\_ontap\_snapshot\_policy](na_ontap_snapshot_policy_module#ansible-collections-netapp-ontap-na-ontap-snapshot-policy-module) – NetApp ONTAP manage Snapshot Policy * [na\_ontap\_snmp](na_ontap_snmp_module#ansible-collections-netapp-ontap-na-ontap-snmp-module) – NetApp ONTAP SNMP community * [na\_ontap\_snmp\_traphosts](na_ontap_snmp_traphosts_module#ansible-collections-netapp-ontap-na-ontap-snmp-traphosts-module) – NetApp ONTAP SNMP traphosts. * [na\_ontap\_software\_update](na_ontap_software_update_module#ansible-collections-netapp-ontap-na-ontap-software-update-module) – NetApp ONTAP Update Software * [na\_ontap\_ssh\_command](na_ontap_ssh_command_module#ansible-collections-netapp-ontap-na-ontap-ssh-command-module) – NetApp ONTAP Run any cli command over plain SSH using paramiko. * [na\_ontap\_storage\_auto\_giveback](na_ontap_storage_auto_giveback_module#ansible-collections-netapp-ontap-na-ontap-storage-auto-giveback-module) – Enables or disables NetApp ONTAP storage auto giveback for a specified node * [na\_ontap\_storage\_failover](na_ontap_storage_failover_module#ansible-collections-netapp-ontap-na-ontap-storage-failover-module) – Enables or disables NetApp Ontap storage failover for a specified node * [na\_ontap\_svm](na_ontap_svm_module#ansible-collections-netapp-ontap-na-ontap-svm-module) – NetApp ONTAP SVM * [na\_ontap\_svm\_options](na_ontap_svm_options_module#ansible-collections-netapp-ontap-na-ontap-svm-options-module) – NetApp ONTAP Modify SVM Options * [na\_ontap\_ucadapter](na_ontap_ucadapter_module#ansible-collections-netapp-ontap-na-ontap-ucadapter-module) – NetApp ONTAP UC adapter configuration * [na\_ontap\_unix\_group](na_ontap_unix_group_module#ansible-collections-netapp-ontap-na-ontap-unix-group-module) – NetApp ONTAP UNIX Group * [na\_ontap\_unix\_user](na_ontap_unix_user_module#ansible-collections-netapp-ontap-na-ontap-unix-user-module) – NetApp ONTAP UNIX users * [na\_ontap\_user](na_ontap_user_module#ansible-collections-netapp-ontap-na-ontap-user-module) – NetApp ONTAP user configuration and management * [na\_ontap\_user\_role](na_ontap_user_role_module#ansible-collections-netapp-ontap-na-ontap-user-role-module) – NetApp ONTAP user role configuration and management * [na\_ontap\_volume](na_ontap_volume_module#ansible-collections-netapp-ontap-na-ontap-volume-module) – NetApp ONTAP manage volumes. * [na\_ontap\_volume\_autosize](na_ontap_volume_autosize_module#ansible-collections-netapp-ontap-na-ontap-volume-autosize-module) – NetApp ONTAP manage volume autosize * [na\_ontap\_volume\_clone](na_ontap_volume_clone_module#ansible-collections-netapp-ontap-na-ontap-volume-clone-module) – NetApp ONTAP manage volume clones. * [na\_ontap\_volume\_efficiency](na_ontap_volume_efficiency_module#ansible-collections-netapp-ontap-na-ontap-volume-efficiency-module) – NetApp ONTAP enables, disables or modifies volume efficiency * [na\_ontap\_volume\_snaplock](na_ontap_volume_snaplock_module#ansible-collections-netapp-ontap-na-ontap-volume-snaplock-module) – NetApp ONTAP manage volume snaplock retention. * [na\_ontap\_vscan](na_ontap_vscan_module#ansible-collections-netapp-ontap-na-ontap-vscan-module) – NetApp ONTAP Vscan enable/disable. * [na\_ontap\_vscan\_on\_access\_policy](na_ontap_vscan_on_access_policy_module#ansible-collections-netapp-ontap-na-ontap-vscan-on-access-policy-module) – NetApp ONTAP Vscan on access policy configuration. * [na\_ontap\_vscan\_on\_demand\_task](na_ontap_vscan_on_demand_task_module#ansible-collections-netapp-ontap-na-ontap-vscan-on-demand-task-module) – NetApp ONTAP Vscan on demand task configuration. * [na\_ontap\_vscan\_scanner\_pool](na_ontap_vscan_scanner_pool_module#ansible-collections-netapp-ontap-na-ontap-vscan-scanner-pool-module) – NetApp ONTAP Vscan Scanner Pools Configuration. * [na\_ontap\_vserver\_cifs\_security](na_ontap_vserver_cifs_security_module#ansible-collections-netapp-ontap-na-ontap-vserver-cifs-security-module) – NetApp ONTAP vserver CIFS security modification * [na\_ontap\_vserver\_peer](na_ontap_vserver_peer_module#ansible-collections-netapp-ontap-na-ontap-vserver-peer-module) – NetApp ONTAP Vserver peering * [na\_ontap\_wait\_for\_condition](na_ontap_wait_for_condition_module#ansible-collections-netapp-ontap-na-ontap-wait-for-condition-module) – NetApp ONTAP wait\_for\_condition. Loop over a get status request until a condition is met. * [na\_ontap\_wwpn\_alias](na_ontap_wwpn_alias_module#ansible-collections-netapp-ontap-na-ontap-wwpn-alias-module) – NetApp ONTAP set FCP WWPN Alias * [na\_ontap\_zapit](na_ontap_zapit_module#ansible-collections-netapp-ontap-na-ontap-zapit-module) – NetApp ONTAP Run any ZAPI on ONTAP See also List of [collections](../../index#list-of-collections) with docs hosted here.	programming_docs
ansible netapp.ontap.na_ontap_fdspt – NetApp ONTAP create, delete or modify File Directory security policy tasks netapp.ontap.na\_ontap\_fdspt – NetApp ONTAP create, delete or modify File Directory security policy tasks ========================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fdspt`. New in version 21.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify or remove file directory security policy tasks. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| access\_control string \| Choices:* file\_directory * slag \| Specifies access control of the task. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| index\_num integer \| \| Specifies the index number of a task. Tasks are applied in order. A task with a larger index value is applied after a task with a lower index number. If you do not specify this optional parameter, new tasks are applied to the end of the index list. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies the name of the policy the task will be associated with. \| \| ntfs\_mode string \| Choices:* propagate * ignore * replace \| Specifies NTFS propagation mode. \| \| ntfs\_sd list / elements=string \| \| Specifies the NTFS security descriptor name. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| path string / required \| \| Specifies the file or folder path of the task. In case of SLAG this path specify the volume or qtree mounted path. \| \| security\_type string \| Choices:* ntfs * nfsv4 \| Specifies the type of security. If not specified ONTAP will default to ntfs. \| \| state string \| Choices:* present ← * absent \| Whether the specified Policy Task should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver for the File Directory security policy. \| Notes ----- Note * check\_mode is supported for this module. * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create File Directory Security Policy Task netapp.ontap.na_ontap_na_ontap_fdspt: state: present name: "ansible_pl" access_control: "file_directory" ntfs_sd: "ansible1_sd" ntfs_mode: "replace" security_type: "ntfs" path: "/volume1" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Modify File Directory Security Policy Task netapp.ontap.na_ontap_na_ontap_fdspt: state: present name: "ansible_pl" access_control: "file_directory" path: "/volume1" ntfs_sd: "ansible1_sd" ntfs_mode: "replace" security_type: "ntfs" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Remove File Directory Security Policy Task netapp.ontap.na_ontap_na_ontap_fdspt: state: absent vserver: "SVM1" name: "ansible_pl" access_control: "file_directory" path: "/volume1" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#cba5ace6aaa5b8a2a9a7aebfaeaaa6ede8f8fcf0ede8fef9f0ede8fff3f0a5aebfaabbbbede8fffdf0a8a4a6)> ansible netapp.ontap.na_ontap_fpolicy_event – NetApp ONTAP FPolicy policy event configuration netapp.ontap.na\_ontap\_fpolicy\_event – NetApp ONTAP FPolicy policy event configuration ======================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fpolicy_event`. New in version 21.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete or modify an FPolicy policy event. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| file\_operations list / elements=string \| Choices:* close * create * create\_dir * delete * delete\_dir * getattr * link * lookup * open * read * write * rename * rename\_dir * setattr * symlink \| Name of file operations to be applied to the event. By default no operations are monitored. \| \| filters list / elements=string \| Choices:* monitor\_ads * close\_with\_modification * close\_without\_modification * first\_read * first\_write * offline\_bit * open\_with\_delete\_intent * open\_with\_write\_intent * write\_with\_size\_change * close\_with\_read * setattr\_with\_owner\_change * setattr\_with\_group\_change * setattr\_with\_sacl\_change * setattr\_with\_dacl\_change * setattr\_with\_modify\_time\_change * setattr\_with\_access\_time\_change * setattr\_with\_creation\_time\_change * setattr\_with\_mode\_change * setattr\_with\_size\_change * setattr\_with\_allocation\_size\_change * exclude\_directory \| Name of filters to be applied to the event. It is notification filtering parameters. By default no filters are selected. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Name of the Event. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| protocol string \| Choices:* cifs * nfsv3 * nfsv4 \| Name of protocol for which event is created. By default no protocol is selected. \| \| state string \| Choices:* present ← * absent \| Whether the FPolicy policy event is present or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volume\_monitoring boolean \| Choices:* no * yes \| Indicator if the volume operation required for the event. If not specified the default Value is false. \| \| vserver string / required \| \| The name of the vserver to create the event on. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create FPolicy Event na_ontap_fpolicy_event: state: present vserver: svm1 name: fpolicy_event file_operations: ['create', 'create_dir', 'delete', 'delete_dir', 'read', 'close', 'rename', 'rename_dir'] filters: ['first_read', 'close_with_modification'] protocol: cifs volume_monitoring: false username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: Modify FPolicy Event na_ontap_fpolicy_event: state: present vserver: svm1 name: fpolicy_event volume_monitoring: true username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: Delete FPolicy Event na_ontap_fpolicy_event: state: absent vserver: svm1 name: fpolicy_event username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#0c626b216d627f656e606978696d612a2f3f3b372a2f393e372a2f3834376269786d7c7c2a2f383a376f6361)> ansible netapp.ontap.na_ontap_igroup_initiator – NetApp ONTAP igroup initiator configuration netapp.ontap.na\_ontap\_igroup\_initiator – NetApp ONTAP igroup initiator configuration ======================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_igroup_initiator`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add/Remove initiators from an igroup Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force\_remove boolean added in 20.1.0 of netapp.ontap \| Choices:* no ← * yes \| Forcibly remove the initiators even if there are existing LUNs mapped to the initiator group. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| initiator\_group string / required \| \| Name of the initiator group to which the initiator belongs. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| names list / elements=string / required \| \| List of initiators to manage. aliases: name \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified initiator should exist or not in an igroup. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Add initiators to an igroup na_ontap_igroup_initiator: names: abc.test:def.com,def.test:efg.com initiator_group: test_group vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Remove an initiator from an igroup na_ontap_igroup_initiator: state: absent names: abc.test:def.com initiator_group: test_group vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c4aaa3e9a5aab7ada6a8a1b0a1a5a9e2e7f7f3ffe2e7f1f6ffe2e7f0fcffaaa1b0a5b4b4e2e7f0f2ffa7aba9)> ansible netapp.ontap.na_ontap_broadcast_domain – NetApp ONTAP manage broadcast domains. netapp.ontap.na\_ontap\_broadcast\_domain – NetApp ONTAP manage broadcast domains. ================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_broadcast_domain`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify a ONTAP broadcast domain. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string added in 2.8.0 of netapp.ontap \| \| Specify the broadcast domain name to be split into new broadcast domain. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ipspace string \| \| Specify the required ipspace for the broadcast domain. A domain ipspace can not be modified after the domain has been created. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| mtu string \| \| Specify the required mtu for the broadcast domain. \| \| name string / required \| \| Specify the broadcast domain name. aliases: broadcast\_domain \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| ports list / elements=string \| \| Specify the ports associated with this broadcast domain. Should be comma separated. It represents the expected state of a list of ports at any time. Add a port if it is specified in expected state but not in current state. Delete a port if it is specified in current state but not in expected state. For split action, it represents the ports to be split from current broadcast domain and added to the new broadcast domain. if all ports are removed or split from a broadcast domain, the broadcast domain will be deleted automatically. \| \| state string \| Choices:* present ← * absent \| Whether the specified broadcast domain should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create broadcast domain na_ontap_broadcast_domain: state: present username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" name: ansible_domain mtu: 1000 ipspace: Default ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13"] - name: modify broadcast domain na_ontap_broadcast_domain: state: present username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" name: ansible_domain mtu: 1100 ipspace: Default ports: ["khutton-vsim1:e0d-12", "khutton-vsim1:e0d-13"] - name: split broadcast domain na_ontap_broadcast_domain: state: present username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" from_name: ansible_domain name: new_ansible_domain mtu: 1200 ipspace: Default ports: khutton-vsim1:e0d-12 - name: delete broadcast domain na_ontap_broadcast_domain: state: absent username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" name: ansible_domain ipspace: Default ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#ef8188c28e819c868d838a9b8a8e82c9ccdcd8d4c9ccdaddd4c9ccdbd7d4818a9b8e9f9fc9ccdbd9d48c8082)>	programming_docs
ansible netapp.ontap.na_ontap_vscan_scanner_pool – NetApp ONTAP Vscan Scanner Pools Configuration. netapp.ontap.na\_ontap\_vscan\_scanner\_pool – NetApp ONTAP Vscan Scanner Pools Configuration. ============================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_vscan_scanner_pool`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Modify/Delete a Vscan Scanner Pool Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| hostnames list / elements=string \| \| 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. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| privileged\_users list / elements=string \| \| List of privileged usernames. Username must be in the form "domain-name\user-name" \| \| scanner\_policy string \| Choices:* primary * secondary * idle \| The name of the Virus scanner Policy \| \| scanner\_pool string / required \| \| the name of the virus scanner pool \| \| state string \| Choices:* present ← * absent \| Whether a Vscan Scanner pool is present or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / 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: Modify scanner pool na_ontap_vscan_scanner_pool: state: present username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: carchi-vsim2 hostnames: ['name', 'name2', 'name3'] privileged_users: ['sim.rtp.openeng.netapp.com\admin', 'sim.rtp.openeng.netapp.com\carchi', 'sim.rtp.openeng.netapp.com\chuyic'] scanner_pool: Scanner1 - 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 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#4628216b2728352f242a233223272b606575717d606573747d6065727e7d282332273636606572707d25292b)> ansible netapp.ontap.na_ontap_cifs_acl – NetApp ONTAP manage cifs-share-access-control netapp.ontap.na\_ontap\_cifs\_acl – NetApp ONTAP manage cifs-share-access-control ================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cifs_acl`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or destroy or modify cifs-share-access-controls on ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| permission string \| Choices:* no\_access * read * change * full\_control \| -"The access rights that the user or group has on the defined CIFS share." \| \| share\_name string / required \| \| The name of the cifs-share-access-control to manage. \| \| state string \| Choices:* present ← * absent \| Whether the specified CIFS share acl should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| user\_or\_group string / required \| \| The user or group name for which the permissions are listed. \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create CIFS share acl na_ontap_cifs_acl: state: present share_name: cifsShareName user_or_group: Everyone permission: read vserver: "{{ netapp_vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify CIFS share acl permission na_ontap_cifs_acl: state: present share_name: cifsShareName user_or_group: Everyone permission: change vserver: "{{ netapp_vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#d7b9b0fab6b9a4beb5bbb2a3b2b6baf1f4e4e0ecf1f4e2e5ecf1f4e3efecb9b2a3b6a7a7f1f4e3e1ecb4b8ba)> ansible netapp.ontap.na_ontap_portset – NetApp ONTAP Create/Delete portset netapp.ontap.na\_ontap\_portset – NetApp ONTAP Create/Delete portset ==================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_portset`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete ONTAP portset, modify ports in a portset. * Modify type(protocol) is not supported in ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force boolean \| Choices:* no ← * yes \| If 'false' or not specified, the request will fail if there are any igroups bound to this portset. If 'true', forcibly destroy the portset, even if there are existing igroup bindings. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Name of the port set to create. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| ports list / elements=string \| \| Specify the ports associated with this portset. Should be comma separated. It represents the expected state of a list of ports at any time, and replaces the current value of ports. Adds a port if it is specified in expected state but not in current state. Deletes a port if it is in current state but not in expected state. \| \| state string \| Default:"present" \| If you want to create a portset. \| \| type string \| Choices:* fcp * iscsi * mixed \| Required for create. Protocols accepted for this portset. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the SVM. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create Portset na_ontap_portset: state: present vserver: vserver_name name: portset_name ports: a1 type: "{{ protocol type }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" - name: Modify ports in portset na_ontap_portset: state: present vserver: vserver_name name: portset_name ports: a1,a2 username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" - name: Delete Portset na_ontap_portset: state: absent vserver: vserver_name name: portset_name force: True type: "{{ protocol type }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#620c054f030c110b000e071607030f444151555944415750594441565a590c07160312124441565459010d0f)> ansible netapp.ontap.na_ontap_lun_map_reporting_nodes – NetApp ONTAP LUN maps reporting nodes netapp.ontap.na\_ontap\_lun\_map\_reporting\_nodes – NetApp ONTAP LUN maps reporting nodes ========================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_lun_map_reporting_nodes`. New in version 21.2.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * And and Remove LUN map reporting nodes. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| initiator\_group\_name string / required \| \| Initiator group to map to the given LUN. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| nodes list / elements=string / required \| \| List of reporting nodes to add or remove \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| path string / required \| \| Path of the LUN. \| \| state string \| Choices:* present ← * absent \| Whether to add or remove reporting nodes \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver owning the LUN. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create Lun Map reporting nodes na_ontap_lun_map_reporting_nodes: hostname: 172.21.121.82 username: admin password: netapp1! https: true validate_certs: false vserver: vs1 state: present initiator_group_name: carchigroup path: /vol/carchiVolTest/carchiLunTest nodes: [node2] - name: Delete Lun Map reporting nodes na_ontap_lun_map_reporting_nodes: hostname: 172.21.121.82 username: admin password: netapp1! https: true validate_certs: false vserver: vs1 state: absent initiator_group_name: carchigroup path: /vol/carchiVolTest/carchiLunTest nodes: [node2] ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#5a343d773b34293338363f2e3f3b377c79696d617c796f68617c796e6261343f2e3b2a2a7c796e6c61393537)>	programming_docs
ansible netapp.ontap.na_ontap_unix_group – NetApp ONTAP UNIX Group netapp.ontap.na\_ontap\_unix\_group – NetApp ONTAP UNIX Group ============================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_unix_group`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete Unix user group Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| id integer \| \| Specifies an identification number for the UNIX group. Group ID is unique for each UNIX group. Required for create, modifiable. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies UNIX group's name, unique for each group. Non-modifiable. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| skip\_name\_validation boolean \| Choices:* no * yes \| Specifies if group name validation is skipped. \| \| state string \| Choices:* present ← * absent \| Whether the specified group should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. aliases: user \| \| users list / elements=string added in 2.9.0 of netapp.ontap \| \| Specifies the users associated with this group. Should be comma separated. It represents the expected state of a list of users at any time. Add a user into group if it is specified in expected state but not in current state. Delete a user from group if it is specified in current state but not in expected state. To delete all current users, use '' as value. \| \| 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 string / required \| \| Specifies the Vserver for the UNIX group. Non-modifiable. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create UNIX group na_ontap_unix_group: state: present name: SampleGroup vserver: ansibleVServer id: 2 users: user1,user2 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete all users in UNIX group na_ontap_unix_group: state: present name: SampleGroup vserver: ansibleVServer users: '' hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete UNIX group na_ontap_unix_group: state: absent name: SampleGroup vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#5638317b3738253f343a332233373b707565616d707563646d7075626e6d383322372626707562606d35393b)> ansible netapp.ontap.na_ontap_svm – NetApp ONTAP SVM netapp.ontap.na\_ontap\_svm – NetApp ONTAP SVM ============================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_svm`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify or delete SVM on NetApp ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| aggr\_list list / elements=string \| \| List of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers. When specified as part of a vserver-create, this field represents the list of aggregates that are assigned to the Vserver for volume operations. When part of vserver-get-iter call, this will return the list of Vservers which have any of the aggregates specified as part of the aggr list. \| \| allowed\_protocols list / elements=string \| \| Allowed Protocols. When specified as part of a vserver-create, this field represent the list of protocols allowed on the Vserver. When part of vserver-get-iter call, this will return the list of Vservers which have any of the protocols specified as part of the allowed-protocols. When part of vserver-modify, this field should include the existing list along with new protocol list to be added to prevent data disruptions. Possible values nfs NFS protocol, cifs CIFS protocol, fcp FCP protocol, iscsi iSCSI protocol, ndmp NDMP protocol - ZAPI only, http HTTP protocol - ZAPI only, nvme NVMe protocol \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| comment string added in 2.8.0 of netapp.ontap \| \| When specified as part of a vserver-create, this field represents the comment associated with the Vserver. When part of vserver-get-iter call, this will return the list of matching Vservers. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string added in 2.7.0 of netapp.ontap \| \| Name of the SVM to be renamed \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ignore\_rest\_unsupported\_options boolean added in 21.10.0 of netapp.ontap \| Choices:* no ← * yes \| When true, ignore `root_volume`, `root_volume_aggregate`, `root_volume_security_style` options if target supports REST. Ignored when `use_rest` is set to never. \| \| ipspace string added in 2.7.0 of netapp.ontap \| \| IPSpace name Cannot be modified after creation. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| language string added in 2.7.0 of netapp.ontap \| \| Language to use for the SVM Default to C.UTF-8 Possible values Language c POSIX ar Arabic cs Czech da Danish de German en English en\_us English (US) es Spanish fi Finnish fr French he Hebrew hr Croatian hu Hungarian it Italian ja Japanese euc-j ja\_v1 Japanese euc-j ja\_jp.pck Japanese PCK (sjis) ja\_jp.932 Japanese cp932 ja\_jp.pck\_v2 Japanese PCK (sjis) ko Korean no Norwegian nl Dutch pl Polish pt Portuguese ro Romanian ru Russian sk Slovak sl Slovenian sv Swedish tr Turkish zh Simplified Chinese zh.gbk Simplified Chinese (GBK) zh\_tw Traditional Chinese euc-tw zh\_tw.big5 Traditional Chinese Big 5 utf8mb4 Most of the values accept a .utf\_8 suffix, e.g. fr.utf\_8 \| \| max\_volumes string added in 21.12.0 of netapp.ontap \| \| Maximum number of volumes that can be created on the vserver. Expects an integer or `unlimited`. \| \| name string / required \| \| The name of the SVM to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| root\_volume string \| \| Root volume of the SVM. Cannot be modified after creation. \| \| root\_volume\_aggregate string \| \| The aggregate on which the root volume will be created. Cannot be modified after creation. \| \| root\_volume\_security\_style string \| Choices:* unix * ntfs * mixed * unified \| Security Style of the root volume. When specified as part of the vserver-create, this field represents the security style for the Vserver root volume. When specified as part of vserver-get-iter call, this will return the list of matching Vservers. The 'unified' security style, which applies only to Infinite Volumes, cannot be applied to a Vserver's root volume. Cannot be modified after creation. \| \| services dictionary added in 21.10.0 of netapp.ontap \| \| Enabled Protocols, only available with REST. The service will be started if needed. A valid license may be required. `enabled` is not supported for CIFS, to enable it use na\_ontap\_cifs\_server. If a service is not present, it is left unchanged. \| \| \| cifs dictionary \| \| CIFS protocol service \| \| \| \| allowed boolean \| Choices:* no * yes \| If true, an SVM administrator can manage the FCP service. If false, only the cluster administrator can manage the service. \| \| \| fcp dictionary \| \| FCP protocol service \| \| \| \| allowed boolean \| Choices:* no * yes \| If true, an SVM administrator can manage the FCP service. If false, only the cluster administrator can manage the service. \| \| \| \| enabled boolean \| Choices:* no * yes \| If allowed, setting to true enables the FCP service. \| \| \| iscsi dictionary \| \| iSCSI protocol service \| \| \| \| allowed boolean \| Choices:* no * yes \| If true, an SVM administrator can manage the FCP service. If false, only the cluster administrator can manage the service. \| \| \| \| enabled boolean \| Choices:* no * yes \| If allowed, setting to true enables the iSCSI service. \| \| \| nfs dictionary \| \| NFS protocol service \| \| \| \| allowed boolean \| Choices:* no * yes \| If true, an SVM administrator can manage the FCP service. If false, only the cluster administrator can manage the service. \| \| \| \| enabled boolean \| Choices:* no * yes \| If allowed, setting to true enables the NFS service. \| \| \| nvme dictionary \| \| nvme protocol service \| \| \| \| allowed boolean \| Choices:* no * yes \| If true, an SVM administrator can manage the FCP service. If false, only the cluster administrator can manage the service. \| \| \| \| enabled boolean \| Choices:* no * yes \| If allowed, setting to true enables the NVMe service. \| \| snapshot\_policy string added in 2.7.0 of netapp.ontap \| \| Default snapshot policy setting for all volumes of the Vserver. This policy will be assigned to all volumes created in this Vserver unless the volume create request explicitly provides a snapshot policy or volume is modified later with a specific snapshot policy. A volume-level snapshot policy always overrides the default Vserver-wide snapshot policy. \| \| state string \| Choices:* present ← * absent \| Whether the specified SVM should exist or not. \| \| subtype string added in 2.7.0 of netapp.ontap \| Choices:* default * dp\_destination * sync\_source * sync\_destination \| The subtype for vserver to be created. Cannot be modified after creation. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create SVM netapp.ontap.na_ontap_svm: state: present name: ansibleVServer root_volume: vol1 root_volume_aggregate: aggr1 root_volume_security_style: mixed hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create SVM netapp.ontap.na_ontap_svm: state: present services: cifs: allowed: true fcp: allowed: true nfs: allowed: true enabled: true hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: true validate_certs: false ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#fa949dd79b94899398969f8e9f9b97dcd9c9cdc1dcd9cfc8c1dcd9cec2c1949f8e9b8a8adcd9ceccc1999597)> ansible netapp.ontap.na_ontap_snapmirror_policy – NetApp ONTAP create, delete or modify SnapMirror policies netapp.ontap.na\_ontap\_snapmirror\_policy – NetApp ONTAP create, delete or modify SnapMirror policies ====================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_snapmirror_policy`. New in version 20.3.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * NetApp ONTAP create, modify, or destroy the SnapMirror policy * Add, modify and remove SnapMirror policy rules * Following parameters are not supported in REST; ‘owner’, ‘restart’, ‘transfer\_priority’, ‘tries’, ‘ignore\_atime’, ‘common\_snapshot\_schedule’ Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| comment string \| \| Specifies the SnapMirror policy comment. \| \| common\_snapshot\_schedule string \| \| Specifies the common Snapshot copy schedule associated with the policy, only required for strict\_sync\_mirror and sync\_mirror. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ignore\_atime boolean \| Choices:* no * yes \| Specifies whether incremental transfers will ignore files which have only their access time changed. Applies to SnapMirror vault relationships only. \| \| is\_network\_compression\_enabled boolean \| Choices:* no * yes \| Specifies whether network compression is enabled for transfers. \| \| keep list / elements=integer added in 20.7.0 of netapp.ontap \| \| SnapMirror policy rule retention count for snapshots created. Required when defining policy rules. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| owner string \| Choices:* cluster\_admin * vserver\_admin \| Specifies the owner of the SnapMirror policy. \| \| password string \| \| Password for the specified user. aliases: pass \| \| policy\_name string / required \| \| Specifies the SnapMirror policy name. \| \| policy\_type string \| Choices:* vault * async\_mirror * mirror\_vault * strict\_sync\_mirror * sync\_mirror \| Specifies the SnapMirror policy type. Modifying the type of an existing SnapMirror policy is not supported \| \| prefix list / elements=string added in 20.7.0 of netapp.ontap \| \| SnapMirror policy rule prefix. Optional when defining policy rules. Set to '' to not set or remove an existing custom prefix. Prefix name should be unique within the policy. When specifying a custom prefix, schedule must also be specified. \| \| restart string \| Choices:* always * never * default \| Defines the behavior of SnapMirror if an interrupted transfer exists, applies to data protection only. \| \| schedule list / elements=string added in 20.7.0 of netapp.ontap \| \| SnapMirror policy rule schedule. Optional when defining policy rules. Set to '' to not set or remove a schedule. When specifying a schedule a custom prefix can be set otherwise the prefix will be set to snapmirror\_label. \| \| snapmirror\_label list / elements=string added in 20.7.0 of netapp.ontap \| \| SnapMirror policy rule label. Required when defining policy rules. Use an empty list to remove all user-defined rules. \| \| state string \| Choices:* present ← * absent \| Whether the specified SnapMirror policy should exist or not. \| \| transfer\_priority string \| Choices:* low * normal \| Specifies the priority at which a SnapMirror transfer runs. \| \| tries string \| \| Specifies the number of tries. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver for the SnapMirror policy. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create SnapMirror policy na_ontap_snapmirror_policy: state: present vserver: "SVM1" policy_name: "ansible_policy" policy_type: "mirror_vault" comment: "created by ansible" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Modify SnapMirror policy na_ontap_snapmirror_policy: state: present vserver: "SVM1" policy_name: "ansible_policy" policy_type: "async_mirror" transfer_priority: "low" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Create SnapMirror policy with basic rules na_ontap_snapmirror_policy: state: present vserver: "SVM1" policy_name: "ansible_policy" policy_type: "async_mirror" snapmirror_label: ['daily', 'weekly', 'monthly'] keep: [7, 5, 12] hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Create SnapMirror policy with rules and schedules (no schedule for daily rule) na_ontap_snapmirror_policy: state: present vserver: "SVM1" policy_name: "ansible_policy" policy_type: "mirror_vault" snapmirror_label: ['daily', 'weekly', 'monthly'] keep: [7, 5, 12] schedule: ['','weekly','monthly'] prefix: ['','','monthly_mv'] hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Modify SnapMirror policy with rules, remove existing schedules and prefixes na_ontap_snapmirror_policy: state: present vserver: "SVM1" policy_name: "ansible_policy" policy_type: "mirror_vault" snapmirror_label: ['daily', 'weekly', 'monthly'] keep: [7, 5, 12] schedule: ['','',''] prefix: ['','',''] hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Modify SnapMirror policy, delete all rules (excludes builtin rules) na_ontap_snapmirror_policy: state: present vserver: "SVM1" policy_name: "ansible_policy" policy_type: "mirror_vault" snapmirror_label: [] hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Delete SnapMirror policy na_ontap_snapmirror_policy: state: absent vserver: "SVM1" policy_type: "async_mirror" policy_name: "ansible_policy" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#93fdf4bef2fde0faf1fff6e7f6f2feb5b0a0a4a8b5b0a6a1a8b5b0a7aba8fdf6e7f2e3e3b5b0a7a5a8f0fcfe)>	programming_docs
ansible netapp.ontap.na_ontap_volume_clone – NetApp ONTAP manage volume clones. netapp.ontap.na\_ontap\_volume\_clone – NetApp ONTAP manage volume clones. ========================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_volume_clone`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create NetApp ONTAP volume clones. * A FlexClone License is required to use this module Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| gid integer added in 2.9.0 of netapp.ontap \| \| The UNIX group ID for the clone volume. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| junction\_path string added in 2.8.0 of netapp.ontap \| \| Junction path of the volume. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the volume clone being created. aliases: volume \| \| ontapi integer \| \| The ontap api version to use \| \| parent\_snapshot string \| \| Parent snapshot in which volume clone is created off. \| \| parent\_volume string / required \| \| The parent volume of the volume clone being created. \| \| parent\_vserver string \| \| Vserver of parent volume in which clone is created off. \| \| password string \| \| Password for the specified user. aliases: pass \| \| qos\_policy\_group\_name string \| \| The qos-policy-group-name which should be set for volume clone. \| \| space\_reserve string \| Choices:* volume * none \| The space\_reserve setting which should be used for the volume clone. \| \| split boolean added in 20.2.0 of netapp.ontap \| Choices:* no * yes \| Split clone volume from parent volume. \| \| state string \| Choices:* present ← \| Whether volume clone should be created. \| \| uid integer added in 2.9.0 of netapp.ontap \| \| The UNIX user ID for the clone volume. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volume\_type string \| Choices:* rw * dp \| The volume-type setting which should be used for the volume clone. \| \| vserver string / required \| \| Vserver in which the volume clone should be created. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create volume clone na_ontap_volume_clone: state: present username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" vserver: vs_hack parent_volume: normal_volume name: clone_volume_7 space_reserve: none parent_snapshot: backup1 junction_path: /clone_volume_7 uid: 1 gid: 1 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#59373e7438372a303b353c2d3c38347f7a6a6e627f7a6c6b627f7a6d6162373c2d3829297f7a6d6f623a3634)> ansible netapp.ontap.na_ontap_security_key_manager – NetApp ONTAP security key manager. netapp.ontap.na\_ontap\_security\_key\_manager – NetApp ONTAP security key manager. =================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_security_key_manager`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add or delete or setup key management on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ip\_address string / required \| \| The IP address of the key management server. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| node string \| \| The node which key management server runs on. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified key manager should exist or not. \| \| tcp\_port integer \| Default:5696 \| The TCP port on which the key management server listens for incoming connections. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Delete Key Manager tags: - delete na_ontap_security_key_manager: state: absent node: swenjun-vsim1 hostname: "{{ hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: False ip_address: 0.0.0.0 - name: Add Key Manager tags: - add na_ontap_security_key_manager: state: present node: swenjun-vsim1 hostname: "{{ hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: False ip_address: 0.0.0.0 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#244a4309454a574d46484150414549020717131f020711161f0207101c1f4a4150455454020710121f474b49)> ansible netapp.ontap.na_ontap_aggregate – NetApp ONTAP manage aggregates. netapp.ontap.na\_ontap\_aggregate – NetApp ONTAP manage aggregates. =================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_aggregate`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete, or manage aggregates on ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| disk\_count integer \| \| Number of disks to place into the aggregate, including parity disks. The disks in this newly-created aggregate come from the spare disk pool. The smallest disks in this pool join the aggregate first, unless the `disk-size` argument is provided. Either `disk-count` or `disks` must be supplied. Range [0..2^31-1]. Required when `state=present`. Modifiable only if specified disk\_count is larger than current disk\_count. Cannot create raidgroup with 1 disk when using raid type raid4. If the disk\_count % raid\_size == 1, only disk\_count/raid\_size \* raid\_size will be added. If disk\_count is 6, raid\_type is raid4, raid\_size 4, all 6 disks will be added. If disk\_count is 5, raid\_type is raid4, raid\_size 4, 5/4 \* 4 = 4 will be added. 1 will not be added. \| \| disk\_size integer added in 2.7.0 of netapp.ontap \| \| Disk size to use in 4K block size. Disks within 10% of specified size will be used. \| \| disk\_size\_with\_unit string \| \| Disk size to use in the specified unit. It is a positive integer number followed by unit of T/G/M/K. For example, 72G, 1T and 32M. This option is ignored if a specific list of disks is specified through the "disks" parameter. You must only use one of either "disk-size" or "disk-size-with-unit" parameters. \| \| disk\_type string added in 2.7.0 of netapp.ontap \| Choices:* ATA * BSAS * FCAL * FSAS * LUN * MSATA * SAS * SSD * VMDISK \| Type of disk to use to build aggregate \| \| disks list / elements=string added in 2.8.0 of netapp.ontap \| \| Specific list of disks to use for the new aggregate. To create a "mirrored" aggregate with a specific list of disks, both 'disks' and 'mirror\_disks' options must be supplied. Additionally, the same number of disks must be supplied in both lists. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string added in 2.7.0 of netapp.ontap \| \| Name of the aggregate to be renamed. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ignore\_pool\_checks boolean added in 20.8.0 of netapp.ontap \| Choices:* no * yes \| only valid when disks option is used. disks in a plex should belong to the same spare pool, and mirror disks to another spare pool. when set to true, these checks are ignored. \| \| is\_mirrored boolean added in 2.8.0 of netapp.ontap \| Choices:* no * yes \| Specifies that the new aggregate be mirrored (have two plexes). If set to true, then the indicated disks will be split across the two plexes. By default, the new aggregate will not be mirrored. This option cannot be used when a specific list of disks is supplied with either the 'disks' or 'mirror\_disks' options. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| mirror\_disks list / elements=string added in 2.8.0 of netapp.ontap \| \| List of mirror disks to use. It must contain the same number of disks specified in 'disks'. \| \| name string / required \| \| The name of the aggregate to manage. \| \| nodes list / elements=string \| \| Node(s) for the aggregate to be created on. If no node specified, mgmt lif home will be used. If multiple nodes specified an aggr stripe will be made. \| \| object\_store\_name string added in 2.9.0 of netapp.ontap \| \| Name of the object store configuration attached to the aggregate \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| raid\_size integer added in 2.7.0 of netapp.ontap \| \| Sets the maximum number of drives per raid group. \| \| raid\_type string added in 2.7.0 of netapp.ontap \| Choices:* raid4 * raid\_dp * raid\_tec * raid\_0 \| Specifies the type of RAID groups to use in the new aggregate. raid\_0 is only available on ONTAP Select. \| \| service\_state string \| Choices:* online * offline \| Whether the specified aggregate should be enabled or disabled. Creates aggregate if doesnt exist. \| \| snaplock\_type string added in 20.1.0 of netapp.ontap \| Choices:* compliance * enterprise * non\_snaplock \| Type of snaplock for the aggregate being created. \| \| spare\_pool string added in 2.8.0 of netapp.ontap \| Choices:* Pool0 * Pool1 \| Specifies the spare pool from which to select spare disks to use in creation of a new aggregate. \| \| state string \| Choices:* present ← * absent \| Whether the specified aggregate should exist or not. \| \| time\_out integer added in 2.8.0 of netapp.ontap \| Default:100 \| time to wait for aggregate creation in seconds default is set to 100 seconds \| \| unmount\_volumes boolean \| Choices:* no * yes \| If set to "TRUE", this option specifies that all of the volumes hosted by the given aggregate are to be unmounted before the offline operation is executed. By default, the system will reject any attempt to offline an aggregate that hosts one or more online volumes. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| wait\_for\_online boolean added in 2.8.0 of netapp.ontap \| Choices:* no ← * yes \| Set this parameter to 'true' for synchronous execution during create (wait until aggregate status is online) Set this parameter to 'false' for asynchronous execution For asynchronous, execution exits as soon as the request is sent, without checking aggregate status \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create Aggregates and wait 5 minutes until aggregate is online na_ontap_aggregate: state: present service_state: online name: ansibleAggr disk_count: 1 wait_for_online: True time_out: 300 snaplock_type: non_snaplock hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Manage Aggregates na_ontap_aggregate: state: present service_state: offline unmount_volumes: true name: ansibleAggr disk_count: 1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Attach object store na_ontap_aggregate: state: present name: aggr4 object_store_name: sgws_305 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Rename Aggregates na_ontap_aggregate: state: present service_state: online from_name: ansibleAggr name: ansibleAggr2 disk_count: 1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete Aggregates na_ontap_aggregate: state: absent service_state: offline unmount_volumes: true name: ansibleAggr hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#49272e6428273a202b252c3d2c28246f6a7a7e726f6a7c7b726f6a7d7172272c3d2839396f6a7d7f722a2624)>	programming_docs
ansible netapp.ontap.na_ontap_fdsd – NetApp ONTAP create or remove a File Directory security descriptor. netapp.ontap.na\_ontap\_fdsd – NetApp ONTAP create or remove a File Directory security descriptor. ================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fdsd`. New in version 21.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or remove a security descriptor. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies the name of the security descriptor. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified security descriptor should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create File Directory Security Descriptor netapp.ontap.na_ontap_fdsd: state: present name: "ansible_sdl" vserver: "svm1" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Delete File Directory Security Descriptor netapp.ontap.na_ontap_fdsd: state: absent vserver: "svm1" name: "ansible_sdl" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1678713b7778657f747a736273777b303525212d303523242d3035222e2d787362776666303522202d75797b)> ansible netapp.ontap.na_ontap_net_ifgrp – NetApp Ontap modify network interface group netapp.ontap.na\_ontap\_net\_ifgrp – NetApp Ontap modify network interface group ================================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_net_ifgrp`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify ports, destroy the network interface group Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| distribution\_function string \| Choices:* mac * ip * sequential * port \| Specifies the traffic distribution function for the ifgrp. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| mode string \| \| Specifies the link policy for the ifgrp. \| \| name string / required \| \| Specifies the interface group name. \| \| node string / required \| \| Specifies the name of node. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| ports list / elements=string added in 2.8.0 of netapp.ontap \| \| List of expected ports to be present in the interface group. If a port is present in this list, but not on the target, it will be added. If a port is not in the list, but present on the target, it will be removed. Make sure the list contains all ports you want to see on the target. aliases: port \| \| state string \| Choices:* present ← * absent \| Whether the specified network interface group should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create ifgrp na_ontap_net_ifgrp: state: present username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" distribution_function: ip name: a0c ports: [e0a] mode: multimode node: "{{ Vsim node name }}" - name: modify ports in an ifgrp na_ontap_net_ifgrp: state: present username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" distribution_function: ip name: a0c port: [e0a, e0c] mode: multimode node: "{{ Vsim node name }}" - name: delete ifgrp na_ontap_net_ifgrp: state: absent username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" name: a0c node: "{{ Vsim node name }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#a8c6cf85c9c6dbc1cac4cddccdc9c58e8b9b9f938e8b9d9a938e8b9c9093c6cddcc9d8d88e8b9c9e93cbc7c5)> ansible netapp.ontap.na_ontap_file_directory_policy – NetApp ONTAP create, delete, or modify vserver security file-directory policy netapp.ontap.na\_ontap\_file\_directory\_policy – NetApp ONTAP create, delete, or modify vserver security file-directory policy =============================================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_file_directory_policy`. New in version 20.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify, or destroy vserver security file-directory policy * Add or remove task from policy. * Each time a policy/task is created/modified, automatically apply policy to vserver. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| access\_control string \| Choices:* file\_directory * slag \| Specifies the access control of task to be applied. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ignore\_broken\_symlinks boolean \| Choices:* no * yes \| Skip Broken Symlinks. Options used when applying the policy to vserver. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ntfs\_mode string \| Choices:* propagate * ignore * replace \| Specifies NTFS Propagation Mode. \| \| ntfs\_sd list / elements=string \| \| Specifies NTFS security descriptor identifier. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| path string \| \| Specifies the file or folder path of the task. If path is specified and the policy which the task is adding to, does not exist, it will create the policy first then add the task to it. If path is specified, delete operation only removes task from policy. \| \| policy\_name string / required \| \| Specifies the name of the policy. \| \| security\_type string \| Choices:* ntfs * nfsv4 \| Specifies the type of security. \| \| state string \| Choices:* present ← * absent \| Whether the specified policy or task should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver for the policy. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create policy na_ontap_file_directory_policy: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" state: present vserver: ansible policy_name: file_policy ignore_broken_symlinks: false - name: add task to existing file_policy na_ontap_file_directory_policy: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" state: present vserver: ansible policy_name: file_policy path: /vol ntfs_sd: ansible_sd ntfs_mode: propagate - name: delete task from file_policy. na_ontap_file_directory_policy: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" state: absent vserver: ansible policy_name: file_policy path: /vol - name: delete file_policy along with the tasks. na_ontap_file_directory_policy: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" state: absent vserver: ansible policy_name: file_policy ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#e78980ca8689948e858b829382868ac1c4d4d0dcc1c4d2d5dcc1c4d3dfdc898293869797c1c4d3d1dc84888a)> ansible netapp.ontap.na_ontap_rest_info – NetApp ONTAP information gatherer using REST APIs netapp.ontap.na\_ontap\_rest\_info – NetApp ONTAP information gatherer using REST APIs ====================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_rest_info`. New in version 20.5.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * This module allows you to gather various information about ONTAP configuration using REST APIs Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| fields list / elements=string added in 20.6.0 of netapp.ontap \| \| Request specific fields from subset. '\' to return all the fields, one or more subsets are allowed. '<list of fields>' to return specified fields, only one subset will be allowed. If the option is not present, return all the fields. \| \| gather\_subset* list / elements=string \| Default:"demo" \| When supplied, this argument will restrict the information collected to a given subset. Either the info name or the REST API can be given. Possible values for this argument include aggregate\_info or storage/aggregates aggr\_efficiency\_info application\_info or application/applications application\_template\_info or application/templates autosupport\_check\_info or support/autosupport/check autosupport\_config\_info or support/autosupport autosupport\_messages\_history or support/autosupport/messages broadcast\_domains\_info or net\_port\_broadcast\_domain\_info or network/ethernet/broadcast-domains cifs\_home\_directory\_info or protocols/cifs/home-directory/search-paths cifs\_services\_info or cifs\_options\_info or protocols/cifs/services cifs\_vserver\_security\_info cifs\_share\_info or protocols/cifs/shares clock\_info cloud\_targets\_info or cloud/targets cluster\_chassis\_info or cluster/chassis cluster\_log\_forwarding\_info or security/audit/destinations cluster\_identity\_info cluster\_jobs\_info or cluster/jobs cluster\_metrics\_info or cluster/metrics cluster\_metrocluster\_diagnostics or metrocluster\_check\_info or cluster/metrocluster/diagnostics cluster\_node\_info or sysconfig\_info or cluster/nodes cluster\_peer\_info or cluster/peers cluster\_schedules or job\_schedule\_cron\_info or cluster/schedules cluster\_software\_download or cluster/software/download cluster\_software\_history or cluster/software/history cluster\_software\_packages or cluster/software/packages cluster\_switch\_info or network/ethernet/switches disk\_info or storage/disks event\_notification\_info or support/ems/destinations event\_notification\_destination\_info or support/ems/destinations export\_policy\_info or protocols/nfs/export-policies file\_directory\_security or private/cli/vserver/security/file-directory initiator\_groups\_info or igroup\_info or protocols/san/igroups ip\_interfaces\_info or net\_interface\_info or network/ip/interfaces ip\_routes\_info or net\_routes\_info or network/ip/routes ip\_service\_policies or net\_interface\_service\_policy\_info or network/ip/service-policies kerberos\_realm\_info or protocols/nfs/kerberos/realms license\_info or cluster/licensing/licenses network\_ipspaces\_info or net\_ipspaces\_info or network/ipspaces network\_ports\_info or net\_port\_info or network/ethernet/ports net\_vlan\_info ntp\_server\_info or cluster/ntp/servers nvme\_info or protocols/nvme/services nvme\_interface\_info or protocols/nvme/interfaces nvme\_subsystem\_info or protocols/nvme/subsystems metrocluster\_info or cluster/metrocluster metrocluster-node-get-iter or cluster/metrocluster/nodes ontap\_system\_version or cluster\_image\_info or cluster/software san\_fc\_logins\_info or network/fc/logins san\_fc\_wppn-aliases or fcp\_alias\_info or network/fc/wwpn-aliases san\_fcp\_services or fcp\_service\_info or protocols/san/fcp/services san\_iscsi\_credentials or protocols/san/iscsi/credentials san\_iscsi\_services or iscsi\_service\_info or protocols/san/iscsi/services san\_lun\_maps or lun\_map\_info or protocols/san/lun-maps security\_login\_info or security\_login\_account\_info or security/accounts security\_login\_rest\_role\_info or security/roles sis\_info sis\_policy\_info or storage/volume-efficiency-policies snapmirror\_destination\_info snapmirror\_info or snapmirror/relationships snapmirror\_policy\_info or snapmirror/policies storage\_bridge\_info or storage/bridges storage\_flexcaches\_info or storage/flexcache/flexcaches storage\_flexcaches\_origin\_info or storage/flexcache/origins storage\_luns\_info or lun\_info or storage/luns storage\_NVMe\_namespaces or nvme\_namespace\_info or storage/namespaces storage\_ports\_info or storage/ports storage\_qos\_policies or qos\_policy\_info or qos\_adaptive\_policy\_info or storage/qos/policies storage\_qtrees\_config or qtree\_info or storage/qtrees storage\_quota\_reports or quota\_report\_info or storage/quota/reports storage\_quota\_policy\_rules or storage/quota/rules storage\_shelves\_config or shelf\_info or storage/shelves storage\_snapshot\_policies or snapshot\_policy\_info or storage/snapshot-policies support\_ems\_config or support/ems support\_ems\_events or support/ems/events support\_ems\_filters or support/ems/filters svm\_dns\_config\_info or net\_dns\_info or name-services/dns svm\_ldap\_config\_info or ldap\_client or ldap\_config or name-services/ldap svm\_name\_mapping\_config\_info or name-services/name-mappings svm\_nis\_config\_info or name-services/nis svm\_peers\_info or vserver\_peer\_info or svm/peers svm\_peer-permissions\_info or svm/peer-permissions sys\_cluster\_alerts or private/support/alerts system\_node\_info vserver\_info or svm/svms vserver\_nfs\_info or nfs\_info or protocols/nfs/services volume\_info or storage/volumes volume\_space\_info vscan\_connection\_status\_all\_info or protocols/vscan/server-status vscan\_status\_info or vscan\_info or protocols/vscan Can specify a list of values to include a larger subset. REST APIs are supported with ONTAP 9.6 onwards. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| max\_records integer \| Default:1024 \| Maximum number of records returned in a single call. \| \| ontapi integer \| \| The ontap api version to use \| \| parameters dictionary added in 20.7.0 of netapp.ontap \| \| Allows for any rest option to be passed in \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| \| deprecated as of 21.1.0. this option was ignored and continues to be ignored. \| \| use\_python\_keys boolean added in 21.9.0 of netapp.ontap \| Choices:* no ← * yes \| If true, / in the returned dictionary keys are translated to \_. It makes it possible to use a . notation when processing the output. For instance ontap\_info["svm/svms"] can be accessed as ontap\_info.svm\_svms. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * security\_login\_role\_config\_info there is no REST equivalent. * security\_login\_role\_info there is no REST equivalent. * security\_key\_manager\_key\_info there is no REST equivalent. * vserver\_motd\_info there is no REST equivalent. * vserver\_login\_banner\_info there is no REST equivalent. * vscan\_connection\_extended\_stats\_info there is no REST equivalent. * env\_sensors\_info there is no REST equivalent. * fcp\_adapter\_info there is no REST equivalent. * net\_dev\_discovery\_info there is no REST equivalent. * net\_failover\_group\_info there is no REST equivalent. * net\_firewall\_info there is no REST equivalent. * ntfs\_dacl\_info there is no REST equivalent. * ntfs\_sd\_info there is no REST equivalent. * role\_info there is not REST equivalent. * subsys\_health\_info there is not REST equivalent. * volume\_move\_target\_aggr\_info there is not REST equivalent. * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: run ONTAP gather facts for vserver info netapp.ontap.na_ontap_rest_info: hostname: "1.2.3.4" username: "testuser" password: "test-password" https: true validate_certs: false use_rest: Always gather_subset: - vserver_info - name: run ONTAP gather facts for aggregate info and volume info netapp.ontap.na_ontap_rest_info: hostname: "1.2.3.4" username: "testuser" password: "test-password" https: true validate_certs: false use_rest: Always gather_subset: - aggregate_info - volume_info - name: run ONTAP gather facts for all subsets netapp.ontap.na_ontap_rest_info: hostname: "1.2.3.4" username: "testuser" password: "test-password" https: true validate_certs: false use_rest: Always gather_subset: - all - name: run ONTAP gather facts for aggregate info and volume info with fields section netapp.ontap.na_ontap_rest_info: hostname: "1.2.3.4" username: "testuser" password: "test-password" https: true fields: - '' validate_certs: false use_rest: Always gather_subset: - aggregate_info - volume_info - name: run ONTAP gather facts for aggregate info with specified fields netapp.ontap.na_ontap_rest_info: hostname: "1.2.3.4" username: "testuser" password: "test-password" https: true fields: - 'uuid' - 'name' - 'node' validate_certs: false use_rest: Always gather_subset: - aggregate_info parameters: recommend: true - name: run ONTAP gather facts for volume info with query on name and state netapp.ontap.na_ontap_rest_info: hostname: "1.2.3.4" username: "testuser" password: "test-password" https: true validate_certs: false gather_subset: - volume_info parameters: name: ansible state: online - name: run ONTAP gather fact to get DACLs netapp.ontap.na_ontap_rest_info: hostname: "1.2.3.4" username: "testuser" password: "test-password" https: true validate_certs: false gather_subset: - file_directory_security parameters: vserver: svm1 path: /vol1/qtree1 use_python_keys: true ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#4e2029632f203d272c222b3a2b2f23686d7d7975686d7b7c75686d7a7675202b3a2f3e3e686d7a78752d2123)>	programming_docs
ansible netapp.ontap.na_ontap_snapshot – NetApp ONTAP manage Snapshots netapp.ontap.na\_ontap\_snapshot – NetApp ONTAP manage Snapshots ================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_snapshot`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Modify/Delete ONTAP snapshots Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| async\_bool boolean \| Choices:* no * yes \| If true, the snapshot is to be created asynchronously. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| comment string \| \| A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters. \| \| expiry\_time string added in 21.8.0 of netapp.ontap \| \| Snapshot expire time. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string added in 2.8.0 of netapp.ontap \| \| Name of the existing snapshot to be renamed to. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ignore\_owners boolean \| Choices:* no * yes \| if this field is true, snapshot will be deleted even if some other processes are accessing it. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| snapmirror\_label string \| \| A human readable SnapMirror Label attached with the snapshot. Size of the label can be at most 31 characters. \| \| snapshot string / required \| \| Name of the snapshot to be managed. The maximum string length is 256 characters. \| \| snapshot\_instance\_uuid string \| \| The 128 bit unique snapshot identifier expressed in the form of UUID. \| \| state string \| Choices:* present ← * absent \| If you want to create/modify a snapshot, or delete it. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volume string / required \| \| Name of the volume on which the snapshot is to be created. \| \| vserver string / required \| \| The Vserver name \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create SnapShot tags: - create na_ontap_snapshot: state: present snapshot: "{{ snapshot name }}" volume: "{{ vol name }}" comment: "i am a comment" expiry_time: "2022-02-04T14:00:00-05:00" vserver: "{{ vserver name }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" - name: delete SnapShot tags: - delete na_ontap_snapshot: state: absent snapshot: "{{ snapshot name }}" volume: "{{ vol name }}" vserver: "{{ vserver name }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" - name: modify SnapShot tags: - modify na_ontap_snapshot: state: present snapshot: "{{ snapshot name }}" comment: "New comments are great" volume: "{{ vol name }}" vserver: "{{ vserver name }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c1afa6eca0afb2a8a3ada4b5a4a0ace7e2f2f6fae7e2f4f3fae7e2f5f9faafa4b5a0b1b1e7e2f5f7faa2aeac)> ansible netapp.ontap.na_ontap_vserver_cifs_security – NetApp ONTAP vserver CIFS security modification netapp.ontap.na\_ontap\_vserver\_cifs\_security – NetApp ONTAP vserver CIFS security modification ================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_vserver_cifs_security`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * modify vserver CIFS security. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_aes\_encryption\_enabled boolean \| Choices:* no * yes \| Determine whether AES-128 and AES-256 encryption mechanisms are enabled for Kerberos-related CIFS communication. \| \| is\_password\_complexity\_required boolean \| Choices:* no * yes \| Determine whether password complexity is required for local users. \| \| is\_signing\_required boolean \| Choices:* no * yes \| Determine whether signing is required for incoming CIFS traffic. \| \| is\_smb\_encryption\_required boolean \| Choices:* no * yes \| Determine whether SMB encryption is required for incoming CIFS traffic. \| \| kerberos\_clock\_skew integer \| \| The clock skew in minutes is the tolerance for accepting tickets with time stamps that do not exactly match the host's system clock. \| \| kerberos\_kdc\_timeout integer \| \| Determine the timeout value in seconds for KDC connections. \| \| kerberos\_renew\_age integer \| \| Determine the maximum amount of time in days for which a ticket can be renewed. \| \| kerberos\_ticket\_age integer \| \| Determine the maximum amount of time in hours that a user's ticket may be used for the purpose of Kerberos authentication. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| lm\_compatibility\_level string \| Choices:* lm\_ntlm\_ntlmv2\_krb * ntlm\_ntlmv2\_krb * ntlmv2\_krb * krb \| Determine the LM compatibility level. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| referral\_enabled\_for\_ad\_ldap boolean \| Choices:* no * yes \| Determine whether LDAP referral chasing is enabled or not for AD LDAP connections. \| \| session\_security\_for\_ad\_ldap string \| Choices:* none * sign * seal \| Determine the level of security required for LDAP communications. \| \| smb1\_enabled\_for\_dc\_connections string \| Choices:* false * true * system\_default \| Determine if SMB version 1 is used for connections to domain controllers. \| \| smb2\_enabled\_for\_dc\_connections string \| Choices:* false * true * system\_default \| Determine if SMB version 2 is used for connections to domain controllers. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| use\_start\_tls\_for\_ad\_ldap boolean \| Choices:* no * yes \| Determine whether to use start\_tls for AD LDAP connections. \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| name of the vserver. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: modify cifs security na_ontap_vserver_cifs_security: hostname: "{{ hostname }}" username: username password: password vserver: ansible is_aes_encryption_enabled: false lm_compatibility_level: lm_ntlm_ntlmv2_krb smb1_enabled_for_dc_connections: system_default smb2_enabled_for_dc_connections: system_default use_start_tls_for_ad_ldap: false referral_enabled_for_ad_ldap: false session_security_for_ad_ldap: none is_signing_required: false is_password_complexity_required: false - name: modify cifs security is_smb_encryption_required na_ontap_vserver_cifs_security: hostname: "{{ hostname }}" username: username password: password vserver: ansible is_smb_encryption_required: false - name: modify cifs security int options na_ontap_vserver_cifs_security: hostname: "{{ hostname }}" username: username password: password vserver: ansible kerberos_clock_skew: 10 kerberos_ticket_age: 10 kerberos_renew_age: 5 kerberos_kdc_timeout: 3 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#244a4309454a574d46484150414549020717131f020711161f0207101c1f4a4150455454020710121f474b49)> ansible netapp.ontap.na_ontap_qos_policy_group – NetApp ONTAP manage policy group in Quality of Service. netapp.ontap.na\_ontap\_qos\_policy\_group – NetApp ONTAP manage policy group in Quality of Service. ==================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_qos_policy_group`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, destroy, modify, or rename QoS policy group on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force boolean \| Choices:* no ← * yes \| Setting to 'true' forces the deletion of the workloads associated with the policy group along with the policy group. \| \| from\_name string \| \| Name of the existing policy group to be renamed to name. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_shared boolean added in 20.12.0 of netapp.ontap \| Choices:* no * yes \| Whether the SLOs of the policy group are shared between the workloads or if the SLOs are applied separately to each workload. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| max\_throughput string \| \| Maximum throughput defined by this policy. \| \| min\_throughput string \| \| Minimum throughput defined by this policy. \| \| name string / required \| \| The name of the policy group to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified policy group should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create qos policy group na_ontap_qos_policy_group: state: present name: policy_1 vserver: policy_vserver max_throughput: 800KB/s,800iops min_throughput: 100iops hostname: 10.193.78.30 username: admin password: netapp1! - name: modify qos policy group max throughput na_ontap_qos_policy_group: state: present name: policy_1 vserver: policy_vserver max_throughput: 900KB/s,800iops min_throughput: 100iops hostname: 10.193.78.30 username: admin password: netapp1! - name: delete qos policy group na_ontap_qos_policy_group: state: absent name: policy_1 vserver: policy_vserver hostname: 10.193.78.30 username: admin password: netapp1! ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#bbd5dc96dad5c8d2d9d7decfdedad69d98888c809d988e89809d988f8380d5decfdacbcb9d988f8d80d8d4d6)> ansible netapp.ontap.na_ontap_flexcache – NetApp ONTAP FlexCache - create/delete relationship netapp.ontap.na\_ontap\_flexcache – NetApp ONTAP FlexCache - create/delete relationship ======================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_flexcache`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete FlexCache volume relationships. * This module does not modify an existing FlexCache volume with two exceptions. * When using REST, a prepopulate can be started on an exising FlexCache volume. * When using REST, the volume can be mounted or unmounted. Set path to ‘’ to unmount it. * It is required the volume is mounted to prepopulate it. * Some actions are also available through the na\_ontap\_volume. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| aggr\_list list / elements=string \| \| List of aggregates to host target FlexCache volume. aliases: aggregates \| \| aggr\_list\_multiplier integer \| \| Aggregate list repeat count. REST - Number of FlexCache constituents per aggregate when the `aggregates` field is mentioned. aliases: constituents\_per\_aggregate \| \| auto\_provision\_as string \| \| Use this parameter to automatically select existing aggregates for volume provisioning. Eg flexgroup Note that the fastest aggregate type with at least one aggregate on each node of the cluster will be selected. Ignored when using REST - omit aggr\_list for automatic selection. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force\_offline boolean \| Choices:* no ← * yes \| Offline FlexCache volume before deleting the FlexCache relationship. The volume will be destroyed and data can be lost. \| \| force\_unmount boolean \| Choices:* no ← * yes \| Unmount FlexCache volume. Delete the junction path at which the volume is mounted before deleting the FlexCache relationship. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| junction\_path string \| \| Junction path of the cache volume. aliases: path \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required added in 21.3.0 of netapp.ontap \| \| Name of the target volume for the FlexCache. aliases: volume \| \| ontapi integer \| \| The ontap api version to use \| \| origin\_cluster string \| \| Name of the origin cluster for the FlexCache. Defaults to cluster associated with target vserver if absent. Not used for creation. \| \| origin\_volume string \| \| Name of the origin volume for the FlexCache. Required for creation. \| \| origin\_vserver string \| \| Name of the origin vserver for the FlexCache. Required for creation. \| \| password string \| \| Password for the specified user. aliases: pass \| \| prepopulate dictionary added in 21.3.0 of netapp.ontap \| \| prepopulate FlexCache with data from origin volume. requires ONTAP 9.8 or later, and REST support. dir\_paths must be set for this option to be effective. \| \| \| dir\_paths list / elements=string / required \| \| List of directory paths in the owning SVM's namespace at which the FlexCache volume is mounted. Path must begin with '/'. \| \| \| exclude\_dir\_paths list / elements=string \| \| Directory path which needs to be excluded from prepopulation. Path must begin with '/'. Requires ONTAP 9.9 or later. \| \| \| force\_prepopulate\_if\_already\_created boolean \| Choices:* no * yes ← \| by default, this module will start a prepopulate task each time it is called, and is not idempotent. if set to false, the prepopulate task is not started if the FlexCache already exists. \| \| \| recurse boolean \| Choices:* no * yes \| Specifies whether or not the prepopulate action should search through the directory-path recursively. If not set, the default value 'true' is used. \| \| size integer \| \| Size of cache volume. \| \| size\_unit string \| Choices:* bytes * b * kb * mb * gb ← * tb * pb * eb * zb * yb \| The unit used to interpret the size parameter. \| \| state string \| Choices:* present ← * absent \| Whether the specified relationship should exist or not. \| \| time\_out integer \| Default:180 \| time to wait for flexcache creation or deletion in seconds if 0, the request is asynchronous default is set to 3 minutes \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the target vserver for the FlexCache. Note that hostname, username, password are intended for the target vserver. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create FlexCache netapp.ontap.na_ontap_flexcache: state: present origin_volume: test_src name: test_dest origin_vserver: ansible_src vserver: ansible_dest hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete FlexCache netapp.ontap.na_ontap_flexcache: state: absent name: test_dest vserver: ansible_dest hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#fc929bd19d928f959e909988999d91dadfcfcbc7dadfc9cec7dadfc8c4c79299889d8c8cdadfc8cac79f9391)>	programming_docs
ansible netapp.ontap.na_ontap_cluster_ha – NetApp ONTAP Manage HA status for cluster netapp.ontap.na\_ontap\_cluster\_ha – NetApp ONTAP Manage HA status for cluster =============================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cluster_ha`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable or disable HA on a cluster Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether HA on cluster should be enabled or disabled. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: "Enable HA status for cluster" na_ontap_cluster_ha: state: present hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#e18f86cc808f9288838d849584808cc7c2d2d6dac7c2d4d3dac7c2d5d9da8f8495809191c7c2d5d7da828e8c)> ansible netapp.ontap.na_ontap_nvme_namespace – NetApp ONTAP Manage NVME Namespace netapp.ontap.na\_ontap\_nvme\_namespace – NetApp ONTAP Manage NVME Namespace ============================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_nvme_namespace`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete NVME namespace Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| block\_size integer added in 20.5.0 of netapp.ontap \| Choices:* 512 * 4096 \| Size in bytes of a logical block. Possible values are 512 (Data ONTAP 9.6 and later), 4096. The default value is 4096. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| ostype string \| Choices:* windows * linux * vmware * xen * hyper\_v \| Specifies the ostype for initiators \| \| password string \| \| Password for the specified user. aliases: pass \| \| path string / required \| \| Namespace path. \| \| size integer \| \| Size in bytes. Range is [0..2^63-1]. \| \| size\_unit string \| Choices:* bytes * b ← * kb * mb * gb * tb * pb * eb * zb * yb \| The unit used to interpret the size parameter. \| \| state string \| Choices:* present ← * absent \| Whether the specified namespace should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create NVME Namespace na_ontap_nvme_namespace: state: present ostype: linux path: /vol/ansible/test size: 20 size_unit: mb vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Create NVME Namespace (Idempotency) na_ontap_nvme_namespace: state: present ostype: linux path: /vol/ansible/test size: 20 size_unit: mb vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#58363f7539362b313a343d2c3d39357e7b6b6f637e7b6d6a637e7b6c6063363d2c3928287e7b6c6e633b3735)> ansible netapp.ontap.na_ontap_vscan_on_demand_task – NetApp ONTAP Vscan on demand task configuration. netapp.ontap.na\_ontap\_vscan\_on\_demand\_task – NetApp ONTAP Vscan on demand task configuration. ================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_vscan_on_demand_task`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Configure on demand task for Vscan Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| cross\_junction boolean \| Choices:* no ← * yes \| Specifies whether the On-Demand task is allowed to cross volume junctions \| \| directory\_recursion boolean \| Choices:* no ← * yes \| Specifies whether the On-Demand task is allowed to recursively scan through sub-directories. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| file\_ext\_to\_exclude list / elements=string \| \| File-Extensions for which scanning must not be performed. File whose extension matches with both inclusion and exclusion list is not considered for scanning. \| \| file\_ext\_to\_include list / elements=string \| \| File extensions for which scanning is considered. The default value is '\', which means that all files are considered for scanning except those which are excluded from scanning. File whose extension matches with both inclusion and exclusion list is not considered for scanning. \| \| hostname* string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| max\_file\_size string \| \| Max file-size (in bytes) allowed for scanning. The default value of 10737418240 (10GB) is taken if not provided at the time of creating a task. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| paths\_to\_exclude list / elements=string \| \| File-paths for which scanning must not be performed. \| \| report\_directory string \| \| Path from the vserver root where task report is created. The path must be a directory and provided in unix-format from the root of the Vserver. Example /vol1/on-demand-reports. \| \| report\_log\_level string \| Choices:* verbose * info * error ← \| Log level for the On-Demand report. \| \| request\_timeout string \| \| Total request-service time-limit in seconds. If the virus-scanner does not respond within the provided time, scan will be timedout. \| \| scan\_files\_with\_no\_ext boolean \| Choices:* no * yes ← \| Specifies whether files without any extension are considered for scanning or not. \| \| scan\_paths list / elements=string \| \| List of paths that need to be scanned. The path must be provided in unix-format and from the root of the Vserver. Example /vol1/large\_files. \| \| scan\_priority string \| Choices:* low ← * normal \| Priority of the On-Demand scan requests generated by this task. \| \| schedule string \| \| Schedule of the task. The task will be run as per the schedule. For running the task immediately, vscan-on-demand-task-run api must be used after creating a task. \| \| state string \| Choices:* present ← * absent \| Whether a Vscan on demand task is present or not \| \| task\_name string / required \| \| Name of the task. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / 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 Vscan On Demand Task na_ontap_vscan_on_demand_task: state: present username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: carchi-vsim2 task_name: carchiOnDemand scan_paths: / report_directory: / file_ext_to_exclude: ['py', 'yml'] max_file_size: 10737418241 paths_to_exclude: ['/tmp', '/var'] report_log_level: info request_timeout: 60 - name: Delete Vscan On Demand Task na_ontap_vscan_on_demand_task: state: absent username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: carchi-vsim2 task_name: carchiOnDemand ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#d8b6bff5b9b6abb1bab4bdacbdb9b5fefbebefe3fefbedeae3fefbece0e3b6bdacb9a8a8fefbeceee3bbb7b5)> ansible netapp.ontap.na_ontap_metrocluster – NetApp ONTAP set up a MetroCluster netapp.ontap.na\_ontap\_metrocluster – NetApp ONTAP set up a MetroCluster ========================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_metrocluster`. New in version 20.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Configure MetroCluster. 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.9 * ONTAP >= 9.8 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * REST support requires ONTAP 9.6 or later. * To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| dr\_pairs list / elements=dictionary / required \| \| disaster recovery pair \| \| \| node\_name string / required \| \| the name of the main node \| \| \| partner\_node\_name string / required \| \| the name of the main partner node \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| partner\_cluster\_name string / required \| \| The name of the partner Cluster \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← \| Present to set up a MetroCluster \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Manage MetroCluster hosts: localhost collections: - netapp.ontap vars: login: &login hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: True validate_certs: False tasks: - name: Create MetroCluster na_ontap_metrocluster: <<: login dr_pairs: - partner_node_name: rha17-a2 node_name: rha17-b2 partner_cluster_name: rha2-b2b1_siteB ``` ### Authors NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#85ebe2a8e4ebf6ece7e9e0f1e0e4e8a3a6b6b2bea3a6b0b7bea3a6b1bdbeebe0f1e4f5f5a3a6b1b3bee6eae8)>	programming_docs
ansible netapp.ontap.na_ontap_lun_copy – NetApp ONTAP copy LUNs netapp.ontap.na\_ontap\_lun\_copy – NetApp ONTAP copy LUNs ========================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_lun_copy`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Copy LUNs on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| destination\_path string / required \| \| Specifies the full path to the new LUN. \| \| destination\_vserver string / required \| \| the name of the Vserver that will host the new LUN. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| source\_path string / required \| \| Specifies the full path to the source LUN. \| \| source\_vserver string \| \| Specifies the name of the vserver hosting the LUN to be copied. \| \| state string \| Choices:* present ← \| Whether the specified LUN should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Copy LUN na_ontap_lun_copy: destination_vserver: ansible destination_path: /vol/test/test_copy_dest_dest_new source_path: /vol/test/test_copy_1 source_vserver: ansible hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b4dad399d5dac7ddd6d8d1c0d1d5d9929787838f929781868f9297808c8fdad1c0d5c4c4929780828fd7dbd9)> ansible netapp.ontap.na_ontap_vscan_on_access_policy – NetApp ONTAP Vscan on access policy configuration. netapp.ontap.na\_ontap\_vscan\_on\_access\_policy – NetApp ONTAP Vscan on access policy configuration. ====================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_vscan_on_access_policy`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Configure on access policy for Vscan (virus scan) Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| file\_ext\_to\_exclude list / elements=string \| \| File extensions for which On-Access scanning must not be performed. \| \| file\_ext\_to\_include list / elements=string \| \| File extensions for which On-Access scanning is considered. The default value is '\', which means that all files are considered for scanning except those which are excluded from scanning. \| \| filters* list / elements=string \| \| A list of filters which can be used to define the scope of the On-Access policy more precisely. The filters can be added in any order. Possible values scan\_ro\_volume Enable scans for read-only volume, scan\_execute\_access Scan only files opened with execute-access (CIFS only) \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_scan\_mandatory boolean \| Choices:* no ← * yes \| Specifies whether access to a file is allowed if there are no external virus-scanning servers available for virus scanning. It is true if not provided at the time of creating a policy. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| max\_file\_size integer \| \| Max file-size (in bytes) allowed for scanning. The default value of 2147483648 (2GB) is taken if not provided at the time of creating a policy. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| paths\_to\_exclude list / elements=string \| \| File paths for which On-Access scanning must not be performed. \| \| policy\_name string / required \| \| The name of the policy \| \| policy\_status boolean added in 20.8.0 of netapp.ontap \| Choices:* no * yes \| Status for the created policy \| \| scan\_files\_with\_no\_ext boolean \| Choices:* no * yes ← \| Specifies whether files without any extension are considered for scanning or not. \| \| state string \| Choices:* present ← * absent \| Whether a Vscan on Access policy is present or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / 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 Vscan On Access Policy na_ontap_vscan_on_access_policy: state: present username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: carchi-vsim2 policy_name: carchi_policy file_ext_to_exclude: ['exe', 'yml'] - name: Create Vscan On Access Policy with Policy Status enabled na_ontap_vscan_on_access_policy: state: present username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: carchi-vsim2 policy_name: carchi_policy file_ext_to_exclude: ['exe', 'yml'] policy_status: True - name: modify Vscan on Access Policy na_ontap_vscan_on_access_policy: state: present username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: carchi-vsim2 policy_name: carchi_policy file_ext_to_exclude: ['exe', 'yml', 'py'] - name: Delete On Access Policy na_ontap_vscan_on_access_policy: state: absent username: '{{ netapp_username }}' password: '{{ netapp_password }}' hostname: '{{ netapp_hostname }}' vserver: carchi-vsim2 policy_name: carchi_policy ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#cda3aae0aca3bea4afa1a8b9a8aca0ebeefefaf6ebeef8fff6ebeef9f5f6a3a8b9acbdbdebeef9fbf6aea2a0)> ansible netapp.ontap.na_ontap_name_service_switch – NetApp ONTAP Manage name service switch netapp.ontap.na\_ontap\_name\_service\_switch – NetApp ONTAP Manage name service switch ======================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_name_service_switch`. * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete/Modify Name Service Switch Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| database\_type string / required \| Choices:* hosts * group * passwd * netgroup * namemap \| Name services switch database. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| sources list / elements=string \| \| Type of sources. Possible values include files,dns,ldap,nis. \| \| state string \| Choices:* present ← * absent \| Whether the specified ns-switch should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create name service database na_ontap_name_service_switch: state: present database_type: namemap sources: files,ldap vserver: "{{ Vserver name }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" - name: modify name service database sources na_ontap_name_service_switch: state: present database_type: namemap sources: files vserver: "{{ Vserver name }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#95fbf2b8f4fbe6fcf7f9f0e1f0f4f8b3b6a6a2aeb3b6a0a7aeb3b6a1adaefbf0e1f4e5e5b3b6a1a3aef6faf8)> ansible netapp.ontap.na_ontap_ntfs_dacl – NetApp Ontap create, delate or modify NTFS DACL (discretionary access control list) netapp.ontap.na\_ontap\_ntfs\_dacl – NetApp Ontap create, delate or modify NTFS DACL (discretionary access control list) ======================================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ntfs_dacl`. New in version 20.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify, or destroy a NTFS DACL Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| access\_type string / required \| Choices:* allow * deny \| Specifies DACL ACE's access type. Possible values. \| \| account string / required \| \| Specifies DACL ACE's SID or domain account name of NTFS security descriptor. \| \| advanced\_access\_rights list / elements=string \| Choices:* read\_data * write\_data * append\_data * read\_ea * write\_ea * execute\_file * delete\_child * read\_attr * write\_attr * delete * read\_perm * write\_perm * write\_owner * full\_control \| Specifies DACL ACE's Advanced access rights. Mutually exclusive with rights. \| \| apply\_to list / elements=string \| Choices:* this\_folder * sub\_folders * files \| Specifies apply DACL entry. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| rights string \| Choices:* no\_access * full\_control * modify * read\_and\_execute * read * write \| Specifies DACL ACE's access rights. Mutually exclusive with advanced\_access\_rights. \| \| security\_descriptor string / required \| \| Specifies the NTFS security descriptor. \| \| state string \| Choices:* present ← * absent \| Whether the specified NTFS DACL should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver for the NTFS DACL. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Add NTFS DACL na_ontap_ntfs_dacl: state: present vserver: SVM1 security_descriptor: ansible_sd access_type: allow account: DOMAIN\Account rights: modify hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Modify NTFS DACL na_ontap_ntfs_dacl: state: present vserver: SVM1 security_descriptor: ansible_sd access_type: full_control account: DOMAIN\Account rights: modify hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Remove NTFS DACL na_ontap_ntfs_dacl: state: absent vserver: SVM1 security_descriptor: ansible_sd account: DOMAIN\Account hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#2e4049034f405d474c424b5a4b4f43080d1d1915080d1b1c15080d1a1615404b5a4f5e5e080d1a18154d4143)>	programming_docs
ansible netapp.ontap.na_ontap_cluster – NetApp ONTAP cluster - create a cluster and add/remove nodes. netapp.ontap.na\_ontap\_cluster – NetApp ONTAP cluster - create a cluster and add/remove nodes. =============================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cluster`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create ONTAP cluster. * Add or remove cluster nodes using cluster\_ip\_address. * Adding a node requires ONTAP 9.3 or better. * Removing a node requires ONTAP 9.4 or better. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| cluster\_contact string added in 19.11.0 of netapp.ontap \| \| Cluster contact, only relevant if performing a modify action. \| \| cluster\_ip\_address string \| \| intra cluster IP address of the node to be added or removed. \| \| cluster\_location string added in 19.11.0 of netapp.ontap \| \| Cluster location, only relevant if performing a modify action. \| \| cluster\_name string \| \| The name of the cluster to manage. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| node\_name string added in 20.9.0 of netapp.ontap \| \| Name of the node to be added or removed from the cluster. Be aware that when adding a node, '-' are converted to '\_' by the ONTAP backend. When creating a cluster, `node_name` is ignored. When adding a node using `cluster_ip_address`, `node_name` is optional. When used to remove a node, `cluster_ip_address` and `node_name` are mutually exclusive. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| single\_node\_cluster boolean added in 19.11.0 of netapp.ontap \| Choices:* no * yes \| Whether the cluster is a single node cluster. Ignored for 9.3 or older versions. If present, it was observed that 'Cluster' interfaces were deleted, whatever the value. \| \| state string \| Choices:* present ← * absent \| Whether the specified cluster should exist (deleting a cluster is not supported). Whether the node identified by its cluster\_ip\_address should be in the cluster or not. \| \| time\_out integer added in 21.1.0 of netapp.ontap \| Default:180 \| time to wait for cluster creation in seconds. Error out if task is not completed in defined time. if 0, the request is asynchronous. default is set to 3 minutes. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * supports REST and ZAPI * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create cluster netapp.ontap.na_ontap_cluster: state: present cluster_name: new_cluster time_out: 0 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Add node to cluster (Join cluster) netapp.ontap.na_ontap_cluster: state: present cluster_ip_address: 10.10.10.10 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Add node to cluster (Join cluster) netapp.ontap.na_ontap_cluster: state: present cluster_ip_address: 10.10.10.10 node_name: my_preferred_node_name hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create a 2 node cluster in one call netapp.ontap.na_ontap_cluster: state: present cluster_name: new_cluster cluster_ip_address: 10.10.10.10 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Remove node from cluster netapp.ontap.na_ontap_cluster: state: absent cluster_ip_address: 10.10.10.10 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Remove node from cluster netapp.ontap.na_ontap_cluster: state: absent node_name: node002 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: modify cluster netapp.ontap.na_ontap_cluster: state: present cluster_contact: testing cluster_location: testing cluster_name: "{{ netapp_cluster}}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#4e2029632f203d272c222b3a2b2f23686d7d7975686d7b7c75686d7a7675202b3a2f3e3e686d7a78752d2123)> ansible netapp.ontap.na_ontap_ssh_command – NetApp ONTAP Run any cli command over plain SSH using paramiko. netapp.ontap.na\_ontap\_ssh\_command – NetApp ONTAP Run any cli command over plain SSH using paramiko. ====================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ssh_command`. New in version 20.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Run cli commands on ONTAP over SSH using paramiko. * Output is returned in `stdout` and `stderr`, and also as `stdout_lines`, `stdout_lines_filtered`, `stderr_lines`. * Note that the module can succeed even though the command failed. You need to analyze stdout and check the results. * If the SSH host key is unknown and accepted, `warnings` is updated. * Options related to ZAPI or REST APIs are ignored. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| accept\_unknown\_host\_keys boolean \| Choices:* no ← * yes \| When false, reject the connection if the host key is not in known\_hosts file. When true, if the host key is unknown, accept it, but report a warning. Note that the key is not added to the file. You could add the key by manually using SSH. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| command string / required \| \| a string containing the command and arguments. \| \| exclude\_lines string \| Default:"" \| return only lines containing string pattern in `stdout_lines_filtered` \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| include\_lines string \| Default:"" \| return only lines containing string pattern in `stdout_lines_filtered` \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| privilege string \| \| privilege level at which to run the command, eg admin, advanced. if set, the command is prefixed with `set -privilege <privilege>;`. \| \| service\_processor boolean \| Choices:* no ← * yes \| whether the target system is ONTAP or the service processor (SP) only menaningful when privilege is set aliases: sp \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: run ontap cli command using SSH na_ontap_ssh_command: hostname: "{{ hostname }}" username: "{{ admin_username }}" password: "{{ admin_password }}" command: version # Same as above, with parameters - name: run ontap cli command na_ontap_ssh_command: hostname: "{{ hostname }}" username: "{{ admin_username }}" password: "{{ admin_password }}" command: node show -fields node,health,uptime,model privilege: admin # Same as above, but with lines filtering - name: run ontap cli command na_ontap_ssh_command: hostname: "{{ hostname }}" username: "{{ admin_username }}" password: "{{ admin_password }}" command: node show -fields node,health,uptime,model exclude_lines: 'ode ' # Exclude lines with 'Node ' or 'node' # use with caution! accept_unknown_host_keys: true privilege: admin - name: run ontap SSH command on SP na_ontap_ssh_command: # <<: sp_login command: sp switch-version privilege: diag sp: true register: result - debug: var=result ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| stdout\_lines\_filtered* list / elements=string \| always \| In addition to stdout and stdout\_lines, a list of non-white lines, excluding last and failed login information. The list can be further refined using the include\_lines and exclude\_lines filters. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#620c054f030c110b000e071607030f444151555944415750594441565a590c07160312124441565459010d0f)> ansible netapp.ontap.na_ontap_restit – NetApp ONTAP Run any REST API on ONTAP netapp.ontap.na\_ontap\_restit – NetApp ONTAP Run any REST API on ONTAP ======================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_restit`. New in version 20.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Call a REST API on ONTAP. * Cluster REST API are run using a cluster admin account. * Vserver REST API can be run using a vsadmin account or using vserver tunneling (cluster admin with vserver\_ options). * In case of success, a json dictionary is returned as `response`. * In case of a REST API error, `status_code`, `error_code`, `error_message` are set to help with diagnosing the issue, * and the call is reported as an error (‘failed’). * Other errors (eg connection issues) are reported as Ansible error. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| api string / required \| \| The REST API to call (eg cluster/software, svms/svm). \| \| body dictionary \| \| A dictionary for the info parameter aliases: info \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hal\_linking boolean \| Choices:* no ← * yes \| if true, HAL-encoded links are returned in the response. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| method string \| Default:"GET" \| The REST method to use. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| query dictionary \| \| A list of dictionaries for the query parameters \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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\_name string \| \| if provided, forces vserver tunneling. username identifies a cluster admin account. \| \| vserver\_uuid string \| \| if provided, forces vserver tunneling. username identifies a cluster admin account. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Ontap REST API hosts: localhost gather_facts: False collections: - netapp.ontap vars: login: &login hostname: "{{ admin_ip }}" username: "{{ admin_username }}" password: "{{ admin_password }}" https: true validate_certs: false svm_login: &svm_login hostname: "{{ svm_admin_ip }}" username: "{{ svm_admin_username }}" password: "{{ svm_admin_password }}" https: true validate_certs: false tasks: - name: run ontap REST API command as cluster admin na_ontap_restit: <<: login api: cluster/software register: result - debug: var=result - assert: { that: result.status_code==200, quiet: True } - name: run ontap REST API command as cluster admin na_ontap_restit: <<: login api: cluster/software query: fields: version register: result - debug: var=result - assert: { that: result.status_code==200, quiet: True } - name: run ontap REST API command as cluster admin na_ontap_restit: <<: login api: svm/svms register: result - debug: var=result - assert: { that: result.status_code==200, quiet: True } - name: run ontap REST API command as cluster admin na_ontap_restit: <<: login api: svm/svms query: fields: aggregates,cifs,nfs,uuid query_fields: name query: trident_svm hal_linking: true register: result - debug: var=result - name: run ontap REST API command as vsadmin na_ontap_restit: <<: svm_login api: svm/svms register: result - debug: var=result - assert: { that: result.status_code==200, quiet: True } - name: run ontap REST API command as vserver tunneling na_ontap_restit: <<: login api: storage/volumes vserver_name: ansibleSVM register: result - debug: var=result - assert: { that: result.status_code==200, quiet: True } - set_fact: uuid: "{{ result.response.records \| json_query(get_uuid) }}" vars: get_uuid: "[? name=='deleteme_ln1'].uuid" - debug: var=uuid - name: run ontap REST API command as DELETE method with vserver tunneling na_ontap_restit: <<: login api: "storage/volumes/{{ uuid[0] }}" method: DELETE vserver_name: ansibleSVM query: return_timeout: 60 register: result when: uuid\|length == 1 - debug: var=result - assert: { that: result.skipped\|default(false) or result.status_code\|default(404) == 200, quiet: True } - name: run ontap REST API command as POST method with vserver tunneling na_ontap_restit: <<: login api: storage/volumes method: POST vserver_name: ansibleSVM query: return_records: "true" return_timeout: 60 body: name: deleteme_ln1 aggregates: - name: aggr1 register: result - debug: var=result - assert: { that: result.status_code==201, quiet: True } - name: run ontap REST API command as DELETE method with vserver tunneling # delete test volume if present na_ontap_restit: <<: login api: "storage/volumes/{{ result.response.records[0].uuid }}" method: DELETE vserver_name: ansibleSVM query: return_timeout: 60 register: result - debug: var=result - assert: { that: result.status_code==200, quiet: True } # error cases - name: run ontap REST API command na_ontap_restit: <<: login api: unknown/endpoint register: result ignore_errors: True - debug: var=result - assert: { that: result.status_code==404, quiet: True } ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| error\_code string \| On error \| If the REST API was executed but failed, the error code set by the REST API. Not present if successful, or if the REST API call cannot be performed. \| \| error\_message string \| On error \| If the REST API was executed but failed, the error message set by the REST API. Not present if successful, or if the REST API call cannot be performed. \| \| response dictionary \| On success \| If successful, a json dictionary returned by the REST API. If the REST API was executed but failed, an empty dictionary. Not present if the REST API call cannot be performed. \| \| status\_code string \| Always \| The http status code. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#97f9f0baf6f9e4fef5fbf2e3f2f6fab1b4a4a0acb1b4a2a5acb1b4a3afacf9f2e3f6e7e7b1b4a3a1acf4f8fa)>	programming_docs
ansible netapp.ontap.na_ontap_iscsi – NetApp ONTAP manage iSCSI service netapp.ontap.na\_ontap\_iscsi – NetApp ONTAP manage iSCSI service ================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_iscsi`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * create, delete, start, stop iSCSI service on SVM. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| service\_state string \| Choices:* started * stopped \| Whether the specified service should running. \| \| state string \| Choices:* present ← * absent \| Whether the service should be present or deleted. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create iscsi service na_ontap_iscsi: state: present service_state: started vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Stop Iscsi service na_ontap_iscsi: state: present service_state: stopped vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete Iscsi service na_ontap_iscsi: state: absent vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#e28c85cf838c918b808e879687838fc4c1d1d5d9c4c1d7d0d9c4c1d6dad98c8796839292c4c1d6d4d9818d8f)> ansible netapp.ontap.na_ontap_ldap – NetApp ONTAP LDAP netapp.ontap.na\_ontap\_ldap – NetApp ONTAP LDAP ================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ldap`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify or delete LDAP on NetApp ONTAP SVM/vserver Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of LDAP client configuration \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| skip\_config\_validation string \| Choices:* true * false \| Skip LDAP validation \| \| state string \| Choices:* present ← * absent \| Whether the LDAP is present or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| vserver/svm configured to use LDAP \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Enable LDAP on SVM na_ontap_ldap: state: present name: 'example_ldap' vserver: 'vserver1' hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * Milan Zink (@zeten30) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c0baa5b4a5aef3f0e6e3f3f7fbe6e3f5f2fbe6e3f4f8fba7ada1a9ace6e3f4f6fba3afad)>/<[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b5d8cfdcdbde939686828e939680878e9396818d8ec7d0d1ddd4c1939681838ed6dad8)> ansible netapp.ontap.na_ontap_lun_map – NetApp ONTAP LUN maps netapp.ontap.na\_ontap\_lun\_map – NetApp ONTAP LUN maps ======================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_lun_map`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Map and unmap LUNs on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| initiator\_group\_name string / required \| \| Initiator group to map to the given LUN. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| lun\_id string \| \| LUN ID assigned for the map. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| path string / required \| \| Path of the LUN.. \| \| state string \| Choices:* present ← * absent \| Whether the specified LUN should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create LUN mapping na_ontap_lun_map: state: present initiator_group_name: ansibleIgroup3234 path: /vol/iscsi_path/iscsi_lun vserver: ci_dev hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Unmap LUN na_ontap_lun_map: state: absent initiator_group_name: ansibleIgroup3234 path: /vol/iscsi_path/iscsi_lun vserver: ci_dev hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| lun\_naa\_id string \| success \| The Network Address Authority (NAA) identifier for the LUN. Sample: 600a0980383045372f5d4c5a70315474 \| \| lun\_node string \| success \| NetApp controller that is hosting the LUN. Sample: node01 \| \| lun\_ostype string \| success \| Specifies the OS of the host accessing the LUN. Sample: vmware \| \| lun\_serial string \| success \| A unique, 12-byte, ASCII string used to identify the LUN. Sample: 80E7/]LZp1Tt \| \| lun\_size integer \| success \| Size of the LUN in bytes. Sample: 2199023255552 \| \| lun\_state string \| success \| Online or offline status of the LUN. Sample: online \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1a747d377b74697378767f6e7f7b773c39292d213c392f28213c392e2221747f6e7b6a6a3c392e2c21797577)> ansible netapp.ontap.na_ontap_active_directory – NetApp ONTAP configure active directory netapp.ontap.na\_ontap\_active\_directory – NetApp ONTAP configure active directory =================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_active_directory`. New in version 20.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Configure Active Directory Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| account\_name string / required \| \| Active Directory account NetBIOS name. \| \| admin\_password string / required \| \| Administrator password required for Active Directory account creation. \| \| admin\_username string / required \| \| Administrator username required for Active Directory account creation. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| domain string \| \| Fully qualified domain name. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force\_account\_overwrite boolean \| Choices:* no * yes \| If true and a machine account with the same name as specified in 'account-name' exists in Active Directory, it will be overwritten and reused. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| organizational\_unit string \| \| Organizational unit under which the Active Directory account will be created. \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the Active Directory should exist or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Ontap test hosts: localhost collections: - netapp.ontap tasks: - name: run ontap active directory na_ontap_active_directory: hostname: 10.193.78.219 username: admin password: netapp1! https: True validate_certs: False vserver: laurentncluster-1 state: present account_name: carchi admin_password: password admin_username: carchi domain: 12 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#3a545d175b54495358565f4e5f5b571c19090d011c190f08011c190e0201545f4e5b4a4a1c190e0c01595557)>	programming_docs
ansible netapp.ontap.na_ontap_autosupport – NetApp ONTAP autosupport netapp.ontap.na\_ontap\_autosupport – NetApp ONTAP autosupport ============================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_autosupport`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable/Disable Autosupport Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_address string added in 2.8.0 of netapp.ontap \| \| specify the e-mail address from which the node sends AutoSupport messages \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| hostname\_in\_subject boolean added in 2.8.0 of netapp.ontap \| Choices:* no * yes \| Specify whether the hostname of the node is included in the subject line of the AutoSupport message. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| local\_collection\_enabled boolean added in 21.5.0 of netapp.ontap \| Choices:* no * yes \| Specify whether collection of AutoSupport data when the AutoSupport daemon is disabled. \| \| mail\_hosts list / elements=string \| \| List of mail server(s) used to deliver AutoSupport messages via SMTP. Both host names and IP addresses may be used as valid input. \| \| max\_http\_size integer added in 21.5.0 of netapp.ontap \| \| Specify delivery size limit for the HTTP transport protocol (in bytes). \| \| max\_smtp\_size integer added in 21.5.0 of netapp.ontap \| \| Specify delivery size limit for the SMTP transport protocol (in bytes). \| \| nht\_data\_enabled boolean added in 21.5.0 of netapp.ontap \| Choices:* no * yes \| Specify whether the disk health data is collected as part of the AutoSupport data. \| \| node\_name string / required \| \| The name of the filer that owns the AutoSupport Configuration. \| \| noteto list / elements=string \| \| Specifies up to five recipients of short AutoSupport e-mail messages. \| \| ondemand\_enabled boolean added in 21.5.0 of netapp.ontap \| Choices:* no * yes \| Specify whether the AutoSupport OnDemand Download feature is enabled. \| \| ontapi integer \| \| The ontap api version to use \| \| partner\_addresses list / elements=string added in 2.8.0 of netapp.ontap \| \| Specifies up to five partner vendor recipients of full AutoSupport e-mail messages. \| \| password string \| \| Password for the specified user. aliases: pass \| \| perf\_data\_enabled boolean added in 21.5.0 of netapp.ontap \| Choices:* no * yes \| Specify whether the performance data is collected as part of the AutoSupport data. \| \| post\_url string \| \| The URL used to deliver AutoSupport messages via HTTP POST \| \| private\_data\_removed boolean added in 21.5.0 of netapp.ontap \| Choices:* no * yes \| Specify the removal of customer-supplied data. \| \| proxy\_url string added in 2.8.0 of netapp.ontap \| \| specify an HTTP or HTTPS proxy if the 'transport' parameter is set to HTTP or HTTPS and your organization uses a proxy. If authentication is required, use the format "username:password@host:port". \| \| reminder\_enabled boolean added in 21.5.0 of netapp.ontap \| Choices:* no * yes \| Specify whether AutoSupport reminders are enabled or disabled. \| \| retry\_count integer added in 21.5.0 of netapp.ontap \| \| Specify the maximum number of delivery attempts for an AutoSupport message. \| \| state string \| Choices:* present ← * absent \| Specifies whether the AutoSupport daemon is present or absent. When this setting is absent, delivery of all AutoSupport messages is turned off. \| \| support boolean \| Choices:* no * yes \| Specifies whether AutoSupport notification to technical support is enabled. \| \| to\_addresses list / elements=string added in 2.8.0 of netapp.ontap \| \| Specifies up to five recipients of full AutoSupport e-mail messages. \| \| transport string \| Choices:* http * https * smtp \| The name of the transport protocol used to deliver AutoSupport messages \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| validate\_digital\_certificate boolean added in 21.5.0 of netapp.ontap \| Choices:* no * yes \| When set to true each node will validate the digital certificates that it receives. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Enable autosupport netapp.ontap.na_ontap_autosupport: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" state: present node_name: test transport: https noteto: [email protected],[email protected] mail_hosts: 1.2.3.4,5.6.7.8 support: False post_url: url/1.0/post - name: Modify autosupport proxy_url with password netapp.ontap.na_ontap_autosupport: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" state: present node_name: test transport: https proxy_url: username:[email protected]:8000 - name: Modify autosupport proxy_url without password netapp.ontap.na_ontap_autosupport: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" state: present node_name: test transport: https proxy_url: [email protected]:8000 - name: Disable autosupport netapp.ontap.na_ontap_autosupport: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" state: absent node_name: test ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#107e773d717e6379727c756475717d363323272b363325222b363324282b7e7564716060363324262b737f7d)> ansible netapp.ontap.na_ontap_mcc_mediator – NetApp ONTAP Add and Remove MetroCluster Mediator netapp.ontap.na\_ontap\_mcc\_mediator – NetApp ONTAP Add and Remove MetroCluster Mediator ========================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_mcc_mediator`. New in version 20.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Add and remove ONTAP MCC Mediator Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| mediator\_address string / required \| \| ip address of the mediator \| \| mediator\_password string / required \| \| password of the mediator \| \| mediator\_user string / required \| \| username of the mediator \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether MCCIP Mediator is present or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Add ONTAP MCCIP Mediator na_ontap_mcc_mediator: state: present hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" mediator_address: mediator_ip mediator_user: metrocluster_admin mediator_password: netapp1! - name: Delete ONTAP MCCIP Mediator na_ontap_mcc_mediator: state: absent hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" mediator_user: metrocluster_admin mediator_password: netapp1! ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#fb959cd69a95889299979e8f9e9a96ddd8c8ccc0ddd8cec9c0ddd8cfc3c0959e8f9a8b8bddd8cfcdc0989496)> ansible netapp.ontap.na_ontap_net_vlan – NetApp ONTAP network VLAN netapp.ontap.na\_ontap\_net\_vlan – NetApp ONTAP network VLAN ============================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_net_vlan`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or Delete a network VLAN Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| node string / required \| \| Node name of VLAN interface. \| \| ontapi integer \| \| The ontap api version to use \| \| parent\_interface string / required \| \| The interface that hosts the VLAN interface. \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified network VLAN should exist or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| vlanid string / required \| \| The VLAN id. Ranges from 1 to 4094. \| Notes ----- Note * The `interface_name` option has been removed and should be deleted from playbooks * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create VLAN na_ontap_net_vlan: state: present vlanid: 13 node: "{{ vlan node }}" parent_interface: "{{ vlan parent interface name }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#18767f3579766b717a747d6c7d79753e3b2b2f233e3b2d2a233e3b2c2023767d6c7968683e3b2c2e237b7775)> ansible netapp.ontap.na_ontap_volume_autosize – NetApp ONTAP manage volume autosize netapp.ontap.na\_ontap\_volume\_autosize – NetApp ONTAP manage volume autosize ============================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_volume_autosize`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify Volume AutoSize Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| grow\_threshold\_percent integer \| \| Specifies the percentage of the flexible volume's capacity at which autogrow is initiated. The default grow threshold varies from 85% to 98%, depending on the volume size. It is an error for the grow threshold to be less than or equal to the shrink threshold. Range between 0 and 100 \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| increment\_size string \| \| Specify the flexible volume's increment size using the following format < number > [k\|m\|g\|t] The amount is the absolute size to set. The trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| maximum\_size string \| \| Specify the flexible volume's maximum allowed size using the following format < number > [k\|m\|g\|t] The amount is the absolute size to set. The trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). The default value is 20% greater than the volume size at the time autosize was enabled. It is an error for the maximum volume size to be less than the current volume size. It is also an error for the maximum size to be less than or equal to the minimum size. \| \| minimum\_size string \| \| Specify the flexible volume's minimum allowed size using the following format < number > [k\|m\|g\|t] The amount is the absolute size to set. The trailing 'k', 'm', 'g', and 't' indicates the desired units, namely 'kilobytes', 'megabytes', 'gigabytes', and 'terabytes' (respectively). The default value is the size of the volume at the time the 'grow\_shrink' mode was enabled. It is an error for the minimum size to be greater than or equal to the maximum size. \| \| mode string \| Choices:* grow * grow\_shrink * off \| Specify the flexible volume's autosize mode of operation. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| reset boolean \| Choices:* no * yes \| Sets the values of maximum\_size, increment\_size, minimum\_size, grow\_threshold\_percent, shrink\_threshold\_percent and mode to their defaults If reset paramater is present system will always perform reset action, so idempotency is not supported. \| \| shrink\_threshold\_percent integer \| \| Specifies the percentage of the flexible volume's capacity at which autoshrink is initiated. The default shrink theshold is 50%. It is an error for the shrink threshold to be greater than or equal to the grow threshold. Range between 0 and 100 \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volume string / required \| \| The name of the flexible volume for which we want to set autosize. \| \| vserver string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Modify volume autosize na_ontap_volume_autosize: hostname: 10.193.79.189 username: admin password: netapp1! volume: ansibleVolumesize12 mode: grow grow_threshold_percent: 99 increment_size: 50m maximum_size: 10g minimum_size: 21m shrink_threshold_percent: 40 vserver: ansible_vserver - name: Reset volume autosize na_ontap_volume_autosize: hostname: 10.193.79.189 username: admin password: netapp1! volume: ansibleVolumesize12 reset: true vserver: ansible_vserver ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#fe9099d39f908d979c929b8a9b9f93d8ddcdc9c5d8ddcbccc5d8ddcac6c5909b8a9f8e8ed8ddcac8c59d9193)>	programming_docs
ansible netapp.ontap.na_ontap_autosupport_invoke – NetApp ONTAP send AutoSupport message netapp.ontap.na\_ontap\_autosupport\_invoke – NetApp ONTAP send AutoSupport message =================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_autosupport_invoke`. New in version 20.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Send an AutoSupport message from a node Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| autosupport\_message string added in 20.8.0 of netapp.ontap \| \| Text sent in the subject line of the AutoSupport message. aliases: message \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string \| \| The name of the node to send the message to. Not specifying this option invokes AutoSupport on all nodes in the cluster. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| type string \| Choices:* test * performance * all ← \| Type of AutoSupport Collection to Issue. \| \| uri string \| \| send the AutoSupport message to the destination you specify instead of the configured destination. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Send message na_ontap_autosupport_invoke: name: node1 message: invoked test autosupport rest uri: http://1.2.3.4/delivery_uri type: test hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#39575e1458574a505b555c4d5c58541f1a0a0e021f1a0c0b021f1a0d0102575c4d5849491f1a0d0f025a5654)> ansible netapp.ontap.na_ontap_domain_tunnel – NetApp ONTAP domain tunnel netapp.ontap.na\_ontap\_domain\_tunnel – NetApp ONTAP domain tunnel =================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_domain_tunnel`. New in version 21.3.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete or modify the domain tunnel. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the domain tunnel should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver that the domain tunnel should be created or deleted on. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create Domain Tunnel na_ontap_domain_tunnel: state: present vserver: svm1 hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f59b92d8949b869c97999081909498d3d6c6c2ced3d6c0c7ced3d6c1cdce9b9081948585d3d6c1c3ce969a98)> ansible netapp.ontap.na_ontap_lun – NetApp ONTAP manage LUNs netapp.ontap.na\_ontap\_lun – NetApp ONTAP manage LUNs ====================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_lun`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, destroy, resize LUNs on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| comment string added in 21.2.0 of netapp.ontap \| \| Optional descriptive comment for the LUN. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| flexvol\_name string \| \| The name of the FlexVol the LUN should exist on. Required if san\_application\_template is not present. Not allowed if san\_application\_template is present. \| \| force\_remove boolean \| Choices:* no ← * yes \| If "true", override checks that prevent a LUN from being destroyed if it is online and mapped. If "false", destroying an online and mapped LUN will fail. \| \| force\_remove\_fenced boolean \| Choices:* no ← * yes \| If "true", override checks that prevent a LUN from being destroyed while it is fenced. If "false", attempting to destroy a fenced LUN will fail. The default if not specified is "false". This field is available in Data ONTAP 8.2 and later. \| \| force\_resize boolean \| Choices:* no ← * yes \| Forcibly reduce the size. This is required for reducing the size of the LUN to avoid accidentally reducing the LUN size. \| \| from\_name string added in 20.12.0 of netapp.ontap \| \| The name of the LUN to be renamed. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the LUN to manage. Or LUN group name (volume name) when san\_application\_template is used. \| \| ontapi integer \| \| The ontap api version to use \| \| os\_type string \| \| The os type for the LUN. aliases: ostype \| \| password string \| \| Password for the specified user. aliases: pass \| \| qos\_adaptive\_policy\_group string added in 21.2.0 of netapp.ontap \| \| The adaptive QoS policy group to be set on the LUN. Defines measurable service level objectives (SLOs) and service level agreements (SLAs) that adjust based on the LUN's allocated space or used space. Requires ONTAP 9.4 or later. \| \| qos\_policy\_group string added in 20.12.0 of netapp.ontap \| \| The QoS policy group to be set on the LUN. \| \| san\_application\_template dictionary added in 20.12.0 of netapp.ontap \| \| additional options when using the application/applications REST API to create LUNs. the module is using ZAPI by default, and switches to REST if san\_application\_template is present. create one or more LUNs (and the associated volume as needed). operations at the LUN level are supported, they require to know the LUN short name. this requires ONTAP 9.8 or higher. The module partially supports ONTAP 9.7 for create and delete operations, but not for modify (API limitations). \| \| \| exclude\_aggregates list / elements=string added in 21.7.0 of netapp.ontap \| \| The list of aggregate names to exclude when creating a volume. Requires ONTAP 9.9.1 GA or better. \| \| \| igroup\_name string \| \| name of the initiator group through which the contents of this application will be accessed. \| \| \| lun\_count integer \| \| number of LUNs in the application component (1 to 32). \| \| \| name string / required \| \| name of the SAN application. \| \| \| protection\_type dictionary \| \| The snasphot policy for the volume supporting the LUNs. \| \| \| \| local\_policy string \| \| The snapshot copy policy for the volume. \| \| \| scope string added in 21.2.0 of netapp.ontap \| Choices:* application * auto ← * lun \| whether the top level name identifies a single LUN or a LUN group (application). By default, the module will try to make the right choice, but can report extra warnings. Setting scope to 'application' is required to convert an existing volume to a smart container. The module reports an error when 'lun' or 'application' is used and the desired action cannot be completed. The module issues warnings when the default 'auto' is used, and there is ambiguity regarding the desired actions. \| \| \| storage\_service string \| Choices:* value * performance * extreme \| The performance service level (PSL) for this volume \| \| \| tiering dictionary \| \| Cloud tiering policy. \| \| \| \| control string \| Choices:* required * best\_effort * disallowed \| Storage tiering placement rules for the container. \| \| \| \| object\_stores list / elements=string \| \| list of object store names for tiering. \| \| \| \| policy string \| Choices:* all * auto * none * snapshot-only \| Cloud tiering policy. \| \| \| total\_size integer added in 21.1.0 of netapp.ontap \| \| The total size of the application component, split across the member LUNs in `total_size_unit`. Recommended when `lun_count` is present. Required when `lun_count` is present and greater than 1. Note - if lun\_count is equal to 1, and total\_size is not present, size is used to maintain backward compatibility. \| \| \| total\_size\_unit string added in 21.1.0 of netapp.ontap \| Choices:* bytes * b * kb * mb * gb * tb * pb * eb * zb * yb \| The unit used to interpret the total\_size parameter. Defaults to size\_unit if not present. \| \| \| use\_san\_application boolean \| Choices:* no * yes ← \| Whether to use the application/applications REST/API to create LUNs. This will default to true if any other suboption is present. \| \| size integer \| \| The size of the LUN in `size_unit`. Required when creating a single LUN if application template is not used. \| \| size\_unit string \| Choices:* bytes * b * kb * mb * gb ← * tb * pb * eb * zb * yb \| The unit used to interpret the size parameter. \| \| space\_allocation boolean added in 2.7.0 of netapp.ontap \| Choices:* no ← * yes \| This enables support for the SCSI Thin Provisioning features. If the Host and file system do not support this do not enable it. \| \| space\_reserve boolean \| Choices:* no * yes ← \| This can be set to "false" which will create a LUN without any space being reserved. \| \| state string \| Choices:* present ← * absent \| Whether the specified LUN should exist or not. \| \| use\_exact\_size boolean added in 20.11.0 of netapp.ontap \| Choices:* no * yes ← \| This can be set to "False" which will round the LUN >= 450g. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create LUN na_ontap_lun: state: present name: ansibleLUN flexvol_name: ansibleVolume vserver: ansibleVServer size: 5 size_unit: mb os_type: linux space_reserve: True hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Resize LUN na_ontap_lun: state: present name: ansibleLUN force_resize: True flexvol_name: ansibleVolume vserver: ansibleVServer size: 5 size_unit: gb hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create LUNs using SAN application tags: create na_ontap_lun: state: present name: ansibleLUN size: 15 size_unit: mb os_type: linux space_reserve: false san_application_template: name: san-ansibleLUN igroup_name: testme_igroup lun_count: 3 protection_type: local_policy: default exclude_aggregates: aggr0 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Convert existing volume to SAN application tags: create na_ontap_lun: state: present name: someVolume size: 22 size_unit: mb os_type: linux space_reserve: false san_application_template: name: san-ansibleLUN igroup_name: testme_igroup lun_count: 3 protection_type: local_policy: default scope: application hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#7719105a1619041e151b120312161a515444404c515442454c5154434f4c191203160707515443414c14181a)>	programming_docs
ansible netapp.ontap.na_ontap_service_policy – NetApp ONTAP service policy configuration netapp.ontap.na\_ontap\_service\_policy – NetApp ONTAP service policy configuration =================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_service_policy`. New in version 21.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add, modify, or remove service policies. * This module requires ONTAP 9.8 or later, and only supports REST. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ipspace string \| \| Name of the ipspace. Required for cluster-scoped service policies. Optional for SVM-scoped service policies. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the service policy. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| scope string \| Choices:* cluster * svm \| Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster". svm is assumed if vserver is set. cluster is assumed is vserver is not set. \| \| services list / elements=string \| Choices:* cluster\_core * intercluster\_core * management\_core * management\_autosupport * management\_bgp * management\_ems * management\_https * management\_ssh * management\_portmap * data\_core * data\_nfs * data\_cifs * data\_flexcache * data\_iscsi * data\_s3\_server * no\_service \| List of services to associate to this service policy. To remove all services, use "no\_service". No other value is allowed if no\_service is present. \| \| state string \| Choices:* present ← * absent \| Whether the specified service policy should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string \| \| The name of the vserver to use. Omit this option for cluster scoped user accounts. \| Notes ----- Note * This module supports check\_mode. * This module is not idempotent if index is omitted. * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create service policy netapp.ontap.na_ontap_service_policy: state: present account: SampleUser index: 0 public_key: "{{ netapp_service_policy }}" vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete single service policy netapp.ontap.na_ontap_service_policy: state: absent account: SampleUser vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify single service policy netapp.ontap.na_ontap_service_policy: state: present account: SampleUser comment: ssh key for XXXX index: 0 vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| cd\_action string \| success \| whether a public key is created or deleted. \| \| modify dictionary \| success \| attributes that were modified if the key already exists. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#dfb1b8f2beb1acb6bdb3baabbabeb2f9fcece8e4f9fceaede4f9fcebe7e4b1baabbeafaff9fcebe9e4bcb0b2)> ansible netapp.ontap.na_ontap_firewall_policy – NetApp ONTAP Manage a firewall policy netapp.ontap.na\_ontap\_firewall\_policy – NetApp ONTAP Manage a firewall policy ================================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_firewall_policy`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Configure firewall on an ONTAP node and manage firewall policy for an ONTAP SVM 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.9 * Python package ipaddress. Install using ‘pip install ipaddress’ * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * REST support requires ONTAP 9.6 or later. * To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allow\_list list / elements=string \| \| A list of IPs and masks to use. The host bits of the IP addresses used in this list must be set to 0. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| enable string \| Choices:* enable * disable \| enable firewall on a node \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| logging string \| Choices:* enable * disable \| enable logging for firewall on a node \| \| node string \| \| The node to run the firewall configuration on \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| policy string \| \| A policy name for the firewall policy \| \| service string \| Choices:* dns * http * https * ndmp * ndmps * ntp * portmap * rsh * snmp * ssh * telnet * none \| The service to apply the policy to https and ssh are not supported starting with ONTAP 9.6 portmap is supported for ONTAP 9.4, 9.5 and 9.6 none is supported for ONTAP 9.8 onwards. \| \| state string \| Choices:* present ← * absent \| Whether to set up a firewall policy or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string \| \| The Vserver to apply the policy to. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create firewall Policy netapp.ontap.na_ontap_firewall_policy: state: present allow_list: [1.2.3.0/24,1.3.0.0/16] policy: pizza service: http vserver: ci_dev hostname: "{{ netapp hostname }}" username: "{{ netapp username }}" password: "{{ netapp password }}" - name: Modify firewall Policy netapp.ontap.na_ontap_firewall_policy: state: present allow_list: [1.5.3.0/24] policy: pizza service: http vserver: ci_dev hostname: "{{ netapp hostname }}" username: "{{ netapp username }}" password: "{{ netapp password }}" - name: Destory firewall Policy netapp.ontap.na_ontap_firewall_policy: state: absent policy: pizza service: http vserver: ci_dev hostname: "{{ netapp hostname }}" username: "{{ netapp username }}" password: "{{ netapp password }}" - name: Enable firewall and logging on a node netapp.ontap.na_ontap_firewall_policy: node: test-vsim1 enable: enable logging: enable hostname: "{{ netapp hostname }}" username: "{{ netapp username }}" password: "{{ netapp password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#a9c7ce84c8c7dac0cbc5ccddccc8c48f8a9a9e928f8a9c9b928f8a9d9192c7ccddc8d9d98f8a9d9f92cac6c4)> ansible netapp.ontap.na_ontap_info – NetApp information gatherer netapp.ontap.na\_ontap\_info – NetApp information gatherer ========================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_info`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module allows you to gather various information about ONTAP configuration 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.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * REST support requires ONTAP 9.6 or later. * To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * netapp\_lib Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| continue\_on\_error list / elements=string \| Default:"never" \| By default, this module fails on the first error. This option allows to provide a list of errors that are not failing the module. Errors in the list are reported in the output, under the related info element, as an "error" entry. Possible values are always, never, missing\_vserver\_api\_error, rpc\_error, other\_error. missing\_vserver\_api\_error - most likely the API is available at cluster level but not vserver level. rpc\_error - some queries are failing because the node cannot reach another node in the cluster. key\_error - a query is failing because the returned data does not contain an expected key. for key errors, make sure to report this in Slack. It may be a change in a new ONTAP version. other\_error - anything not in the above list. always will continue on any error, never will fail on any error, they cannot be used with any other keyword. \| \| desired\_attributes dictionary added in 20.6.0 of netapp.ontap \| \| Advanced feature requiring to understand ZAPI internals. Allows to request a specific attribute that is not returned by default, or to limit the returned attributes. A dictionary for the zapi desired-attributes element. An XML tag <tag>value</tag> is a dictionary with tag as the key. Value can be another dictionary, a list of dictionaries, a string, or nothing. eg <tag/> is represented as tag: Only a single subset can be called at a time if this option is set. It is the caller responsibity to make sure key attributes are present in the right position. The module will error out if any key attribute is missing. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| gather\_subset list / elements=string \| Default:"all" \| When supplied, this argument will restrict the information collected to a given subset. Possible values for this argument include aggregate\_info aggr\_efficiency\_info autosupport\_check\_info cifs\_options\_info cifs\_server\_info cifs\_share\_info cifs\_vserver\_security\_info cluster\_identity\_info cluster\_image\_info cluster\_log\_forwarding\_info cluster\_node\_info cluster\_peer\_info cluster\_switch\_info clock\_info disk\_info env\_sensors\_info event\_notification\_destination\_info event\_notification\_info export\_policy\_info export\_rule\_info fcp\_adapter\_info fcp\_alias\_info fcp\_service\_info igroup\_info iscsi\_service\_info job\_schedule\_cron\_info kerberos\_realm\_info ldap\_client ldap\_config license\_info lun\_info lun\_map\_info metrocluster\_check\_info metrocluster\_info metrocluster\_node\_info net\_dev\_discovery\_info net\_dns\_info net\_failover\_group\_info net\_firewall\_info net\_ifgrp\_info net\_interface\_info net\_interface\_service\_policy\_info net\_ipspaces\_info net\_port\_info net\_port\_broadcast\_domain\_info net\_routes\_info net\_vlan\_info nfs\_info ntfs\_dacl\_info ntfs\_sd\_info ntp\_server\_info nvme\_info nvme\_interface\_info nvme\_namespace\_info nvme\_subsystem\_info ontap\_system\_version ontap\_version ontapi\_version qos\_adaptive\_policy\_info qos\_policy\_info qtree\_info quota\_report\_info role\_info security\_key\_manager\_key\_info security\_login\_account\_info security\_login\_role\_config\_info security\_login\_role\_info service\_processor\_info service\_processor\_network\_info shelf\_info sis\_info sis\_policy\_info snapmirror\_info snapmirror\_destination\_info snapmirror\_policy\_info snapshot\_info snapshot\_policy\_info storage\_failover\_info storage\_bridge\_info subsys\_health\_info sysconfig\_info sys\_cluster\_alerts volume\_info volume\_space\_info vscan\_info vscan\_status\_info vscan\_scanner\_pool\_info vscan\_connection\_status\_all\_info vscan\_connection\_extended\_stats\_info vserver\_info vserver\_login\_banner\_info vserver\_motd\_info vserver\_nfs\_info vserver\_peer\_info Can specify a list of values to include a larger subset. Values can also be used with an initial `M(!`) to specify that a specific subset should not be collected. nvme is supported with ONTAP 9.4 onwards. use "help" to get a list of supported information for your system. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| max\_records integer added in 20.2.0 of netapp.ontap \| Default:1024 \| Maximum number of records returned in a single ZAPI call. Valid range is [1..2^32-1]. This parameter controls internal behavior of this module. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| query dictionary added in 20.7.0 of netapp.ontap \| \| Advanced feature requiring to understand ZAPI internals. Allows to specify which objects to return. A dictionary for the zapi query element. An XML tag <tag>value</tag> is a dictionary with tag as the key. Value can be another dictionary, a list of dictionaries, a string, or nothing. eg <tag/> is represented as tag: Only a single subset can be called at a time if this option is set. \| \| state string \| \| deprecated as of 21.1.0. this option was ignored and continues to be ignored. \| \| summary boolean added in 20.4.0 of netapp.ontap \| Choices:* no ← * yes \| Boolean flag to control return all attributes of the module info or only the names. If true, only names are returned. \| \| use\_native\_zapi\_tags boolean added in 20.6.0 of netapp.ontap \| Choices:* no ← * yes \| By default, - in the returned dictionary keys are translated to \_. If set to true, the translation is disabled. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volume\_move\_target\_aggr\_info dictionary added in 20.5.0 of netapp.ontap \| \| Required options for volume\_move\_target\_aggr\_info \| \| \| volume\_name string / required added in 20.5.0 of netapp.ontap \| \| Volume name to get target aggr info for \| \| \| vserver string / required added in 20.5.0 of netapp.ontap \| \| vserver the Volume lives on \| \| vserver string added in 19.11.0 of netapp.ontap \| \| If present, 'vserver tunneling' will limit the output to the vserver scope. Note that not all subsets are supported on a vserver, and 'all' will trigger an error. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Get NetApp info as Cluster Admin (Password Authentication) na_ontap_info: hostname: "na-vsim" username: "admin" password: "admins_password" register: ontap_info - debug: msg: "{{ ontap_info.ontap_info }}" - name: Get NetApp version as Vserver admin na_ontap_info: hostname: "na-vsim" username: "vsadmin" vserver: trident_svm password: "vsadmins_password" - name: run ontap info module using vserver tunneling and ignoring errors na_ontap_info: hostname: "na-vsim" username: "admin" password: "admins_password" vserver: trident_svm summary: true continue_on_error: - missing_vserver_api_error - rpc_error - name: Limit Info Gathering to Aggregate Information as Cluster Admin na_ontap_info: hostname: "na-vsim" username: "admin" password: "admins_password" gather_subset: "aggregate_info" register: ontap_info - name: Limit Info Gathering to Volume and Lun Information as Cluster Admin na_ontap_info: hostname: "na-vsim" username: "admin" password: "admins_password" gather_subset: - volume_info - lun_info register: ontap_info - name: Gather all info except for volume and lun information as Cluster Admin na_ontap_info: hostname: "na-vsim" username: "admin" password: "admins_password" gather_subset: - "!volume_info" - "!lun_info" register: ontap_info - name: Gather Volume move information for a specific volume na_ontap_info: hostname: "na-vsim" username: "admin" password: "admins_password" gather_subset: volume_move_target_aggr_info volume_move_target_aggr_info: volume_name: carchitest vserver: ansible - name: run ontap info module for aggregate module, requesting specific fields na_ontap_info: # <<: login gather_subset: aggregate_info desired_attributes: aggr-attributes: aggr-inode-attributes: files-private-used: aggr-raid-attributes: aggregate-type: use_native_zapi_tags: true register: ontap - debug: var=ontap - name: run ontap info to get offline volumes with dp in the name na_ontap_info: # <<: cert_login gather_subset: volume_info query: volume-attributes: volume-id-attributes: name: 'dp' volume-state-attributes: state: offline desired_attributes: volume-attributes: volume-id-attributes: name: volume-state-attributes: state: register: ontap - debug: var=ontap ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| ontap\_info dictionary \| always \| Returns various information about NetApp cluster configuration Sample: { "ontap\_info": { "aggregate\_info": {...}, "autosupport\_check\_info": {...}, "cluster\_identity\_info": {...}, "cluster\_image\_info": {...}, "cluster\_node\_info": {...}, "igroup\_info": {...}, "iscsi\_service\_info": {...}, "license\_info": {...}, "lun\_info": {...}, "metrocluster\_check\_info": {...}, "metrocluster\_info": {...}, "metrocluster\_node\_info": {...}, "net\_dns\_info": {...}, "net\_ifgrp\_info": {...}, "net\_interface\_info": {...}, "net\_interface\_service\_policy\_info": {...}, "net\_port\_info": {...}, "ontap\_system\_version": {...}, "ontap\_version": {...}, "ontapi\_version": {...}, "qos\_policy\_info": {...}, "qos\_adaptive\_policy\_info": {...}, "qtree\_info": {...}, "quota\_report\_info": {...}, "security\_key\_manager\_key\_info": {...}, "security\_login\_account\_info": {...}, "snapmirror\_info": {...} "snapmirror\_destination\_info": {...} "storage\_bridge\_info": {...} "storage\_failover\_info": {...}, "volume\_info": {...}, "vserver\_login\_banner\_info": {...}, "vserver\_motd\_info": {...}, "vserver\_info": {...}, "vserver\_nfs\_info": {...}, "vscan\_status\_info": {...}, "vscan\_scanner\_pool\_info": {...}, "vscan\_connection\_status\_all\_info": {...}, "vscan\_connection\_extended\_stats\_info": {...} } \| ### Authors * Piotr Olczak (@dprts) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#24544b48475e454f020717131f020711161f0207101c1f5641404c4550020710121f474b49)>	programming_docs
ansible netapp.ontap.na_ontap_unix_user – NetApp ONTAP UNIX users netapp.ontap.na\_ontap\_unix\_user – NetApp ONTAP UNIX users ============================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_unix_user`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete or modify UNIX users local to ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| full\_name string \| \| Specifies the full name of the UNIX user Optional for create, modifiable. \| \| group\_id integer \| \| Specifies the primary group identification number for the UNIX user Required for create, modifiable. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| id integer \| \| Specifies an identification number for the UNIX user. Required for create, modifiable. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies user's UNIX account name. Non-modifiable. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified user should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the Vserver for the UNIX user. Non-modifiable. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create UNIX User na_ontap_unix_user: state: present name: SampleUser vserver: ansibleVServer group_id: 1 id: 2 full_name: Test User hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete UNIX User na_ontap_unix_user: state: absent name: SampleUser vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#dcb2bbf1bdb2afb5beb0b9a8b9bdb1faffefebe7faffe9eee7faffe8e4e7b2b9a8bdacacfaffe8eae7bfb3b1)> ansible netapp.ontap.na_ontap_fdsp – NetApp ONTAP create or delete a file directory security policy netapp.ontap.na\_ontap\_fdsp – NetApp ONTAP create or delete a file directory security policy ============================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fdsp`. New in version 21.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or delete a file directory security policy. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies the name of the policy. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified policy should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver for the security policy. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create File Directory Security Policy netapp.ontap.na_ontap_fdsp: state: present name: "ansible_security_policyl" vserver: "svm1" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Delete File Directory Security Policy netapp.ontap.na_ontap_fdsp: state: absent vserver: "svm1" name: "ansible_security_policyl" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#ec828bc18d829f858e808998898d81cacfdfdbd7cacfd9ded7cacfd8d4d78289988d9c9ccacfd8dad78f8381)> ansible netapp.ontap.na_ontap_svm_options – NetApp ONTAP Modify SVM Options netapp.ontap.na\_ontap\_svm\_options – NetApp ONTAP Modify SVM Options ====================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_svm_options`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify ONTAP SVM Options * Only Options that appear on “vserver options show” can be set Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string \| \| Name of the option. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| value string \| \| Value of the option. Value must be in quote \| \| vserver string / required \| \| The name of the vserver to which this option belongs to. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Set SVM Options na_ontap_svm_options: vserver: "{{ netapp_vserver_name }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" name: snmp.enable value: 'on' ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#4a242d672b24392328262f3e2f2b276c69797d716c697f78716c697e7271242f3e2b3a3a6c697e7c71292527)> ansible netapp.ontap.na_ontap_snapshot_policy – NetApp ONTAP manage Snapshot Policy netapp.ontap.na\_ontap\_snapshot\_policy – NetApp ONTAP manage Snapshot Policy ============================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_snapshot_policy`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Modify/Delete ONTAP snapshot policies Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| comment string \| \| A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters. \| \| count list / elements=integer \| \| Retention count for the snapshots created by the schedule. \| \| enabled boolean \| Choices:* no * yes \| Status of the snapshot policy indicating whether the policy will be enabled or disabled. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Name of the snapshot policy to be managed. The maximum string length is 256 characters. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| prefix list / elements=string added in 19.10.1 of netapp.ontap \| \| Snapshot name prefix for the schedule. Prefix name should be unique within the policy. Cannot set a different prefix to a schedule that has already been assigned to a snapshot policy. Prefix cannot be modifed after schedule has been added. \| \| schedule list / elements=string \| \| Schedule to be added inside the policy. \| \| snapmirror\_label list / elements=string added in 2.9.0 of netapp.ontap \| \| SnapMirror label assigned to each schedule inside the policy. Use an empty string ('') for no label. \| \| state string \| Choices:* present ← * absent \| If you want to create, modify or delete a snapshot policy. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string added in 2.9.0 of netapp.ontap \| \| The name of the vserver to use. In a multi-tenanted environment, assigning a Snapshot Policy to a vserver will restrict its use to that vserver. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create Snapshot policy na_ontap_snapshot_policy: state: present name: ansible2 schedule: hourly prefix: hourly count: 150 enabled: True username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" https: False - name: Create Snapshot policy with multiple schedules na_ontap_snapshot_policy: state: present name: ansible2 schedule: ['hourly', 'daily', 'weekly', 'monthly', '5min'] prefix: ['hourly', 'daily', 'weekly', 'monthly', '5min'] count: [1, 2, 3, 4, 5] enabled: True username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" https: False - name: Create Snapshot policy owned by a vserver na_ontap_snapshot_policy: state: present name: ansible3 vserver: ansible schedule: ['hourly', 'daily', 'weekly', 'monthly', '5min'] prefix: ['hourly', 'daily', 'weekly', 'monthly', '5min'] count: [1, 2, 3, 4, 5] snapmirror_label: ['hourly', 'daily', 'weekly', 'monthly', ''] enabled: True username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" https: False - name: Modify Snapshot policy with multiple schedules na_ontap_snapshot_policy: state: present name: ansible2 schedule: ['daily', 'weekly'] count: [20, 30] snapmirror_label: ['daily', 'weekly'] enabled: True username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" https: False - name: Delete Snapshot policy na_ontap_snapshot_policy: state: absent name: ansible2 username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" https: False ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#137d743e727d607a717f766776727e353020242835302621283530272b287d76677263633530272528707c7e)>	programming_docs
ansible netapp.ontap.na_ontap_volume_efficiency – NetApp ONTAP enables, disables or modifies volume efficiency netapp.ontap.na\_ontap\_volume\_efficiency – NetApp ONTAP enables, disables or modifies volume efficiency ========================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_volume_efficiency`. New in version 21.2.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable, modify or disable volume efficiency Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| enable\_compression boolean \| Choices:* no * yes \| Specifies if compression is to be enabled. \| \| enable\_cross\_volume\_background\_dedupe boolean \| Choices:* no * yes \| Specifies if cross volume background deduplication is to be enabled, this can only be enabled when inline deduplication is enabled. \| \| enable\_cross\_volume\_inline\_dedupe boolean \| Choices:* no * yes \| Specifies if in-line cross volume inline deduplication is to be enabled, this can only be enabled when inline deduplication is enabled. \| \| enable\_data\_compaction boolean \| Choices:* no * yes \| Specifies if compaction is to be enabled. \| \| enable\_inline\_compression boolean \| Choices:* no * yes \| Specifies if in-line compression is to be enabled. \| \| enable\_inline\_dedupe boolean \| Choices:* no * yes \| Specifies if in-line deduplication is to be enabled, only supported on AFF systems or hybrid aggregates. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| path string / required \| \| Specifies the path for the volume. \| \| policy string \| Choices:* auto * default * inline-only * - \| Specifies the storage efficiency policy to use, only supported on AFF systems. \| \| schedule string \| \| Specifies the storage efficiency schedule. \| \| start\_ve\_build\_metadata boolean added in 21.4.0 of netapp.ontap \| Choices:* no * yes \| Specifies the scanner to scan the entire and generate fingerprint database without attempting the sharing. \| \| start\_ve\_delete\_checkpoint boolean added in 21.4.0 of netapp.ontap \| Choices:* no * yes \| Specifies the scanner to delete existing checkpoint and start the operation from the begining. \| \| start\_ve\_qos\_policy string added in 21.4.0 of netapp.ontap \| Choices:* background * best-effort ← \| Specifies the QoS policy for the operation. \| \| start\_ve\_queue\_operation boolean added in 21.4.0 of netapp.ontap \| Choices:* no * yes \| Specifies the operation to queue if an exisitng operation is already running on the volume and in the fingerprint verification phase. \| \| start\_ve\_scan\_all boolean added in 21.4.0 of netapp.ontap \| Choices:* no * yes \| Specifies the scanner to scan the entire volume without applying share block optimization. \| \| start\_ve\_scan\_old\_data boolean added in 21.4.0 of netapp.ontap \| Choices:* no * yes \| Specifies the operation to scan the file system to process all the existing data. \| \| state string \| Choices:* present ← * absent \| Whether the specified volume efficiency should be enabled or not. \| \| stop\_ve\_all\_operations boolean added in 21.4.0 of netapp.ontap \| Choices:* no * yes \| Specifies that all running and queued operations to be stopped. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volume\_efficiency string added in 21.4.0 of netapp.ontap \| Choices:* start * stop \| Start or Stop a volume efficiency operation on a given volume path. \| \| vserver string / required \| \| Specifies the vserver for the volume. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Enable Volume efficiency na_ontap_volume_efficiency: state: present vserver: "TESTSVM" path: "/vol/test_sis" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Disable Volume efficiency test na_ontap_volume_efficiency: state: absent vserver: "TESTSVM" path: "/vol/test_sis" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Modify storage efficiency policy na_ontap_volume_efficiency: state: present vserver: "TESTSVM" path: "/vol/test_sis" schedule: "mon-sun@0,1,23" enable_compression: "True" enable_inline_compression: "True" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Start volume efficiency na_ontap_volume_efficiency: state: present vserver: "TESTSVM" volume_efficiency: "start" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Stop volume efficiency na_ontap_volume_efficiency: state: present vserver: "TESTSVM" volume_efficiency: "stop" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1d737a307c736e747f717869787c703b3e2e2a263b3e282f263b3e2925267378697c6d6d3b3e292b267e7270)> ansible netapp.ontap.na_ontap_security_certificates – NetApp ONTAP manage security certificates. netapp.ontap.na\_ontap\_security\_certificates – NetApp ONTAP manage security certificates. =========================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_security_certificates`. New in version 20.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Install or delete security certificates on ONTAP. (Create and sign will come in a second iteration) Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| common\_name string \| \| Common name of the certificate. Required for create and install. If name is present, ignored for sign and delete. If name is absent or ignored, required for sign and delete. \| \| expiry\_time string \| \| Certificate expiration time. Specifying an expiration time is recommended when creating a certificate. Can be provided when signing a certificate. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hash\_function string \| \| Hashing function. Can be provided when creating a self-signed certificate or when signing a certificate. Allowed values for create and sign are sha256, sha224, sha384, sha512. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ignore\_name\_if\_not\_supported boolean added in 20.8.0 of netapp.ontap \| Choices:* no * yes ← \| ONTAP 9.6 and 9.7 REST API does not support name. If set to true, no error is reported if name is present, and name is not used. \| \| intermediate\_certificates list / elements=string \| \| Chain of intermediate Certificates in PEM format. Only valid when installing a certificate. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| key\_size integer \| \| Key size of the certificate in bits. Specifying a strong key size is recommended when creating a certificate. Ignored for sign and delete. \| \| name string \| \| The unique name of the security certificate per SVM. This parameter is not supported for ONTAP 9.6 or 9.7, as the REST API does not support it. If present with ONTAP 9.6 or 9.7, it is ignored by default, see ignore\_name\_if\_not\_supported. It is strongly recommended to use name for newer releases of ONTAP. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| private\_key string \| \| Private key certificate in PEM format. Required when installing a CA-signed certificate. Ignored otherwise. \| \| public\_certificate string \| \| Public key certificate in PEM format. Required when installing a certificate. Ignored otherwise. \| \| signing\_request string \| \| If present, the certificate identified by name and svm is used to sign the request. A signed certificate is returned. \| \| state string \| Choices:* present ← * absent \| Whether the specified security certificate should exist or not. \| \| svm string \| \| The name of the SVM (vserver). If present, the certificate is installed in the SVM. If absent, the certificate is installed in the cluster. aliases: vserver \| \| type string \| Choices:* client * server * client\_ca * server\_ca * root\_ca \| Type of certificate Required for create and install. If name is present, ignored for sign and delete. If name is absent or ignored, required for sign and delete. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: install certificate na_ontap_security_certificates: # <<: cert_login common_name: "{{ ontap_cert_common_name }}" name: "{{ ontap_cert_name }}" public_certificate: "{{ ssl_certificate }}" type: client_ca svm: "{{ vserver }}" - name: create certificate na_ontap_security_certificates: # <<: cert_login common_name: "{{ ontap_cert_root_common_name }}" name: "{{ ontap_cert_name }}" type: root_ca svm: "{{ vserver }}" expiry_time: P365DT # one year - name: sign certificate using newly create certificate tags: sign_request na_ontap_security_certificates: # <<: login name: "{{ ontap_cert_name }}" svm: "{{ vserver }}" signing_request: \| -----BEGIN CERTIFICATE REQUEST----- MIIChDCCAWwCAQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRIwEAYDVQQH DAlTdW5ueXZhbGUxDzANBgNVBAoMBk5ldEFwcDCCASIwDQYJKoZIhvcNAQEBBQAD ggEPADCCAQoCggEBALgXCj6Si/I4xLdV7wjWYTbt8jY20fQOjk/4E7yBT1vFBflE ks6YDc6dhC2G18cnoj9E3DiR8lIHPoAlFB/VmBNDev3GZkbFlrbV7qYmf8OEx2H2 tAefgSP0jLmCHCN1yyhJoCG6FsAiD3tf6yoyFF6qS9ureGL0tCJJ/osx64WzUz+Q EN8lx7VSxriEFMSjreXZDhUFaCdIYKKRENuEWyYvdy5cbBmczhuM8EP6peOVv5Hm BJzPUDkq7oTtEHmttpATq2Y92qzNzETO0bXN5X/93AWri8/yEXdX+HEw1C/omtsE jGsCXrCrIJ+DgUdT/GHNdBWlXl/cWGtEgEQ4vrUCAwEAAaAAMA0GCSqGSIb3DQEB CwUAA4IBAQBjZNoQgr/JDm1T8zyRhLkl3zw4a16qKNu/MS7prqZHLVQgrptHRegU Hbz11XoHfVOdbyuvtzEe95QsDd6FYCZ4qzZRF3se4IjMeqwdQZ5WP0/GFiwM8Uln /0TCWjt759XMeUX7+wgOg5NRjJ660eWMXzu/UJf+vZO0Q2FiPIr13JvvY3TjT+9J UUtK4r9PaUuOPN2YL9IQqSD3goh8302Qr3nBXUgjeUGLkgfUM5S39apund2hyTX2 JCLQsKr88pwU9iDho2tHLv/2QgLwNZLPu8V+7IGu6G4vB28lN4Uy7xbhxFOKtyWu fK4sEdTw3B/aDN0tB8MHFdPYycNZsEac -----END CERTIFICATE REQUEST----- expiry_time: P180DT - name: delete certificate na_ontap_security_certificates: # <<: cert_login state: absent name: "{{ ontap_cert_name }}" svm: "{{ vserver }}" # For ONTAP 9.6 or 9.7, use common_name and type, in addition to, or in lieu of name - name: install certificate na_ontap_security_certificates: # <<: cert_login common_name: "{{ ontap_cert_common_name }}" public_certificate: "{{ ssl_certificate }}" type: client_ca svm: "{{ vserver }}" - name: create certificate na_ontap_security_certificates: # <<: cert_login common_name: "{{ ontap_cert_root_common_name }}" type: root_ca svm: "{{ vserver }}" expiry_time: P365DT # one year - name: sign certificate using newly create certificate tags: sign_request na_ontap_security_certificates: # <<: login common_name: "{{ ontap_cert_root_common_name }}" type: root_ca svm: "{{ vserver }}" signing_request: \| -----BEGIN CERTIFICATE REQUEST----- MIIChDCCAWwCAQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRIwEAYDVQQH DAlTdW5ueXZhbGUxDzANBgNVBAoMBk5ldEFwcDCCASIwDQYJKoZIhvcNAQEBBQAD ggEPADCCAQoCggEBALgXCj6Si/I4xLdV7wjWYTbt8jY20fQOjk/4E7yBT1vFBflE ks6YDc6dhC2G18cnoj9E3DiR8lIHPoAlFB/VmBNDev3GZkbFlrbV7qYmf8OEx2H2 tAefgSP0jLmCHCN1yyhJoCG6FsAiD3tf6yoyFF6qS9ureGL0tCJJ/osx64WzUz+Q EN8lx7VSxriEFMSjreXZDhUFaCdIYKKRENuEWyYvdy5cbBmczhuM8EP6peOVv5Hm BJzPUDkq7oTtEHmttpATq2Y92qzNzETO0bXN5X/93AWri8/yEXdX+HEw1C/omtsE jGsCXrCrIJ+DgUdT/GHNdBWlXl/cWGtEgEQ4vrUCAwEAAaAAMA0GCSqGSIb3DQEB CwUAA4IBAQBjZNoQgr/JDm1T8zyRhLkl3zw4a16qKNu/MS7prqZHLVQgrptHRegU Hbz11XoHfVOdbyuvtzEe95QsDd6FYCZ4qzZRF3se4IjMeqwdQZ5WP0/GFiwM8Uln /0TCWjt759XMeUX7+wgOg5NRjJ660eWMXzu/UJf+vZO0Q2FiPIr13JvvY3TjT+9J UUtK4r9PaUuOPN2YL9IQqSD3goh8302Qr3nBXUgjeUGLkgfUM5S39apund2hyTX2 JCLQsKr88pwU9iDho2tHLv/2QgLwNZLPu8V+7IGu6G4vB28lN4Uy7xbhxFOKtyWu fK4sEdTw3B/aDN0tB8MHFdPYycNZsEac -----END CERTIFICATE REQUEST----- expiry_time: P180DT - name: delete certificate na_ontap_security_certificates: # <<: cert_login state: absent common_name: "{{ ontap_cert_root_common_name }}" type: root_ca name: "{{ ontap_cert_name }}" svm: "{{ vserver }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| ontap\_info dictionary \| always \| Returns public\_certificate when signing, empty for create, install, and delete. Sample: { "ontap\_info": { "public\_certificate": "-----BEGIN CERTIFICATE----- ........-----END CERTIFICATE----- " } } \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#e08e87cd818e9389828c859485818dc6c3d3d7dbc6c3d5d2dbc6c3d4d8db8e8594819090c6c3d4d6db838f8d)>	programming_docs
ansible netapp.ontap.na_ontap_igroup – NetApp ONTAP iSCSI or FC igroup configuration netapp.ontap.na\_ontap\_igroup – NetApp ONTAP iSCSI or FC igroup configuration ============================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_igroup`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete/Rename Igroups and Modify initiators belonging to an igroup Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| bind\_portset string \| \| Name of a current portset to bind to the newly created igroup. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force\_remove\_initiator boolean \| Choices:* no ← * yes \| Forcibly remove the initiator even if there are existing LUNs mapped to this initiator group. aliases: allow\_delete\_while\_mapped \| \| from\_name string added in 2.7.0 of netapp.ontap \| \| Name of igroup to rename to name. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| igroups list / elements=string added in 21.3.0 of netapp.ontap \| \| List of igroups to be mapped to the igroup. For a modify operation, this list replaces the existing igroups, or existing initiators. This module does not add or remove specific igroup(s) in an igroup. Mutually exclusive with initiator\_names (initiators) and initiator\_objects. Requires ONTAP 9.9 or newer. \| \| initiator\_group\_type string \| Choices:* fcp * iscsi * mixed \| Type of the initiator group. Required when `state=present`. aliases: protocol \| \| initiator\_names list / elements=string added in 21.4.0 of netapp.ontap \| \| List of initiators to be mapped to the igroup. WWPN, WWPN Alias, or iSCSI name of Initiator to add or remove. For a modify operation, this list replaces the existing initiators, or existing igroups. This module does not add or remove specific initiator(s) in an igroup. Mutually exclusive with igroups and initiator\_objects. This serves the same purpose as initiator\_objects, but without the comment suboption. aliases: initiator, initiators \| \| initiator\_objects list / elements=dictionary added in 21.4.0 of netapp.ontap \| \| List of initiators to be mapped to the igroup, with an optional comment field. WWPN, WWPN Alias, or iSCSI name of Initiator to add or remove. For a modify operation, this list replaces the existing initiators, or existing igroups. This module does not add or remove specific initiator(s) in an igroup. Mutually exclusive with initiator\_names (initiators) and igroups. Requires ONTAP 9.9 with REST support. \| \| \| comment string \| \| a more descriptive comment as the WWPN can be quite opaque. \| \| \| name string / required \| \| name of the initiator. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the igroup to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| os\_type string \| \| OS type of the initiators within the group. aliases: ostype \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified Igroup should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create iSCSI Igroup na_ontap_igroup: state: present name: ansibleIgroup3 initiator_group_type: iscsi os_type: linux initiator_names: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com,abc.com:redhat.com vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create iSCSI Igroup - ONTAP 9.9 na_ontap_igroup: state: present name: ansibleIgroup3 initiator_group_type: iscsi os_type: linux initiator_objects: - name: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com comment: for test only - name: abc.com:redhat.com vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create FC Igroup na_ontap_igroup: state: present name: ansibleIgroup4 initiator_group_type: fcp os_type: linux initiator_names: 20:00:00:50:56:9f:19:82 vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: rename Igroup na_ontap_igroup: state: present from_name: ansibleIgroup3 name: testexamplenewname initiator_group_type: iscsi os_type: linux initiator_names: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify Igroup Initiators (replaces exisiting initiator_names) na_ontap_igroup: state: present name: ansibleIgroup3 initiator_group_type: iscsi os_type: linux initiator: iqn.1994-05.com.redhat:scspa0395855001.rtp.openenglab.netapp.com vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete Igroup na_ontap_igroup: state: absent name: ansibleIgroup3 vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#bcd2db91ddd2cfd5ded0d9c8d9ddd19a9f8f8b879a9f898e879a9f888487d2d9c8ddcccc9a9f888a87dfd3d1)> ansible netapp.ontap.na_ontap_motd – Setup motd netapp.ontap.na\_ontap\_motd – Setup motd ========================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_motd`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * This module allows you to manipulate motd for a vserver * It also allows to manipulate motd at the cluster level by using the cluster vserver (cserver) 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.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * REST support requires ONTAP 9.6 or later. * To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * netapp\_lib Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| motd\_message string \| \| MOTD Text message. aliases: message \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| show\_cluster\_motd boolean \| Choices:* no * yes ← \| Set to false if Cluster-level Message of the Day should not be shown \| \| state string \| Choices:* present ← * absent \| If `state=present` sets MOTD given in message `state=absent` removes it. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the SVM motd should be set for. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Set Cluster-Level MOTD na_ontap_motd: vserver: my_ontap_cluster motd_message: "Cluster wide MOTD" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" state: present https: true - name: Set MOTD for I(rhev_nfs_krb) SVM, do not show Cluster-Level MOTD na_ontap_motd: vserver: rhev_nfs_krb motd_message: "Access to rhev_nfs_krb is also restricted" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" state: present show_cluster_motd: False https: true - name: Remove Cluster-Level MOTD na_ontap_motd: vserver: my_ontap_cluster hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" state: absent https: true ``` ### Authors * Piotr Olczak (@dprts) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#3e4e51525d445f55181d0d0905181d0b0c05181d0a06054c5b5a565f4a181d0a08055d5153)> * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#0769602a6669746e656b627362666a212434303c212432353c2124333f3c696273667777212433313c64686a)> ansible netapp.ontap.na_ontap_cifs – NetApp ONTAP Manage cifs-share netapp.ontap.na\_ontap\_cifs – NetApp ONTAP Manage cifs-share ============================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cifs`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or destroy or modify(path) cifs-share on ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| comment string added in 21.7.0 of netapp.ontap \| \| The CIFS share description. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| path string \| \| The file system path that is shared through this CIFS share. The path is the full, user visible path relative to the vserver root, and it might be crossing junction mount points. The path is in UTF8 and uses forward slash as directory separator. \| \| share\_name string / required \| \| The name of the CIFS share. The CIFS share name is a UTF-8 string with the following characters being illegal; control characters from 0x00 to 0x1F, both inclusive, 0x22 (double quotes) \| \| share\_properties list / elements=string added in 2.8.0 of netapp.ontap \| \| The list of properties for the CIFS share. \| \| state string \| Choices:* present ← * absent \| Whether the specified CIFS share should exist or not. \| \| symlink\_properties list / elements=string added in 2.8.0 of netapp.ontap \| \| The list of symlink properties for this CIFS share. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| vscan\_fileop\_profile string added in 2.9.0 of netapp.ontap \| Choices:* no\_scan * standard * strict * writes\_only \| Profile\_set of file\_ops to which vscan on access scanning is applicable. \| \| vserver string / required \| \| Vserver containing the CIFS share. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create CIFS share netapp.ontap.na_ontap_cifs: state: present share_name: cifsShareName path: / vserver: vserverName share_properties: browsable,oplocks symlink_properties: read_only,enable comment: CIFS share description hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete CIFS share netapp.ontap.na_ontap_cifs: state: absent share_name: cifsShareName vserver: vserverName hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify path CIFS share netapp.ontap.na_ontap_cifs: state: present share_name: pb_test vserver: vserverName path: / share_properties: show_previous_versions symlink_properties: disable vscan_fileop_profile: no_scan hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#650b0248040b160c07090011000408434656525e434650575e4346515d5e0b0011041515434651535e060a08)>	programming_docs
ansible netapp.ontap.na_ontap_ipspace – NetApp ONTAP Manage an ipspace netapp.ontap.na\_ontap\_ipspace – NetApp ONTAP Manage an ipspace ================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ipspace`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Manage an ipspace for an Ontap Cluster Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string \| \| Name of the existing ipspace to be renamed to name \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the ipspace to manage \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified ipspace should exist or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create ipspace na_ontap_ipspace: state: present name: ansibleIpspace hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete ipspace na_ontap_ipspace: state: absent name: ansibleIpspace hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Rename ipspace na_ontap_ipspace: state: present name: ansibleIpspace_newname from_name: ansibleIpspace hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NTTE Storage Engineering (@vicmunoz) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#a2c1ce8481969499c7ccc58481969499d1d6cd848191959984819790998481969a99ccd6d68481969499c7d7)> ansible netapp.ontap.na_ontap_storage_auto_giveback – Enables or disables NetApp ONTAP storage auto giveback for a specified node netapp.ontap.na\_ontap\_storage\_auto\_giveback – Enables or disables NetApp ONTAP storage auto giveback for a specified node ============================================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_storage_auto_giveback`. New in version 21.3.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable or disable storage auto giveback Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| auto\_giveback\_after\_panic\_enabled boolean \| Choices:* no * yes \| specifies whether auto give back on panic should be enabled or disabled \| \| auto\_giveback\_enabled boolean / required \| Choices:* no * yes \| specifies whether auto give back should be enabled or disabled \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies the node name to enable or disable storage auto giveback on. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Enable storage auto giveback na_ontap_storage_auto_giveback: name: node1 auto_giveback_enabled: true auto_giveback_after_panic_enabled: true hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Disable storage auto giveback na_ontap_storage_auto_giveback: name: node1 auto_giveback_enabled: false auto_giveback_after_panic_enabled: false hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#83ede4aee2edf0eae1efe6f7e6e2eea5a0b0b4b8a5a0b6b1b8a5a0b7bbb8ede6f7e2f3f3a5a0b7b5b8e0ecee)> ansible netapp.ontap.na_ontap_rest_cli – NetApp ONTAP run any CLI command using REST api/private/cli/ netapp.ontap.na\_ontap\_rest\_cli – NetApp ONTAP run any CLI command using REST api/private/cli/ ================================================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_rest_cli`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Run CLI commands on ONTAP through REST api/private/cli/. * This module can run as admin or vsdamin and requires HTTP application to be enabled. * Access permissions can be customized using ONTAP rest-role. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| body dictionary \| \| a dictionary for info specification \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| command string / required \| \| a string command. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| params dictionary \| \| a dictionary of parameters to pass into the api call \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| verb string / required \| Choices:* GET * POST * PATCH * DELETE * OPTIONS \| a string indicating which api call to run OPTIONS is useful to know which verbs are supported by the REST API \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: run ontap rest cli command netapp.ontap.na_ontap_rest_cli: hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" command: 'version' verb: 'GET' - name: run ontap rest cli command netapp.ontap.na_ontap_rest_cli: hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" command: 'security/login/motd' verb: 'PATCH' params: {'vserver': 'ansibleSVM'} body: {'message': 'test'} ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#cda3aae0aca3bea4afa1a8b9a8aca0ebeefefaf6ebeef8fff6ebeef9f5f6a3a8b9acbdbdebeef9fbf6aea2a0)> ansible netapp.ontap.na_ontap_command – NetApp ONTAP Run any cli command, the username provided needs to have console login permission. netapp.ontap.na\_ontap\_command – NetApp ONTAP Run any cli command, the username provided needs to have console login permission. ================================================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_command`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Run system-cli commands on ONTAP * Can’t be used with cert authentication and domain authentication accounts. * Requires ontapi and console permissions. Console is not supported for data vservers. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| command list / elements=string / required \| \| a comma separated list containing the command and arguments. \| \| exclude\_lines string added in 19.10.0 of netapp.ontap \| Default:"" \| applied only when return\_dict is true return only lines containing string pattern in `stdout_lines_filter` \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| include\_lines string added in 19.10.0 of netapp.ontap \| Default:"" \| applied only when return\_dict is true return only lines containing string pattern in `stdout_lines_filter` \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| privilege string added in 2.8.0 of netapp.ontap \| Choices:* admin ← * advanced \| privilege level at which to run the command. \| \| return\_dict boolean added in 2.9.0 of netapp.ontap \| Choices:* no ← * yes \| Returns a parsesable dictionary instead of raw XML output `result_value` `status` > passed, failed. `stdout` > command output in plaintext. `stdout_lines` > list of command output lines. `stdout_lines_filter` > empty list or list of command output lines matching include\_lines or exclude\_lines parameters. `xml_dict` > JSON representation of what the CLI returned. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string added in 19.10.0 of netapp.ontap \| \| If running as vserver admin, you must give a vserver or module will fail \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: run ontap cli command netapp.ontap.na_ontap_command: hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" command: ['version'] # Same as above, but returns parseable dictonary - name: run ontap cli command netapp.ontap.na_ontap_command: hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" command: ['node', 'show', '-fields', 'node,health,uptime,model'] privilege: 'admin' return_dict: true # Same as above, but with lines filtering - name: run ontap cli command netapp.ontap.na_ontap_command: hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" command: ['node', 'show', '-fields', 'node,health,uptime,model'] exlude_lines: 'ode ' # Exclude lines with 'Node ' or 'node' privilege: 'admin' return_dict: true ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b6d8d19bd7d8c5dfd4dad3c2d3d7db909585818d909583848d9095828e8dd8d3c2d7c6c6909582808dd5d9db)>	programming_docs
ansible netapp.ontap.na_ontap_ndmp – NetApp ONTAP NDMP services configuration netapp.ontap.na\_ontap\_ndmp – NetApp ONTAP NDMP services configuration ======================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ndmp`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify NDMP Services. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| abort\_on\_disk\_error boolean \| Choices:* no * yes \| Enable abort on disk error. \| \| authtype list / elements=string \| \| Authentication type. \| \| backup\_log\_enable boolean \| Choices:* no * yes \| Enable backup log. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| data\_port\_range string \| \| Data port range. Modification not supported for data Vservers. \| \| debug\_enable boolean \| Choices:* no * yes \| Enable debug. \| \| debug\_filter string \| \| Debug filter. \| \| dump\_detailed\_stats boolean \| Choices:* no * yes \| Enable logging of VM stats for dump. \| \| dump\_logical\_find string \| \| Enable logical find for dump. \| \| enable boolean \| Choices:* no * yes \| Enable NDMP on vserver. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| fh\_dir\_retry\_interval integer \| \| FH throttle value for dir. \| \| fh\_node\_retry\_interval integer \| \| FH throttle value for node. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ignore\_ctime\_enabled boolean \| Choices:* no * yes \| Ignore ctime. \| \| is\_secure\_control\_connection\_enabled boolean \| Choices:* no * yes \| Is secure control connection enabled. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| offset\_map\_enable boolean \| Choices:* no * yes \| Enable offset map. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| per\_qtree\_exclude\_enable boolean \| Choices:* no * yes \| Enable per qtree exclusion. \| \| preferred\_interface\_role list / elements=string \| \| Preferred interface role. \| \| restore\_vm\_cache\_size integer \| \| Restore VM file cache size. Value range [4-1024] \| \| secondary\_debug\_filter string \| \| Secondary debug filter. \| \| tcpnodelay boolean \| Choices:* no * yes \| Enable TCP nodelay. \| \| tcpwinsize integer \| \| TCP window size. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: modify ndmp na_ontap_ndmp: vserver: ansible hostname: "{{ hostname }}" abort_on_disk_error: true authtype: plaintext,challenge backup_log_enable: true data_port_range: 8000-9000 debug_enable: true debug_filter: filter dump_detailed_stats: true dump_logical_find: default enable: true fh_dir_retry_interval: 100 fh_node_retry_interval: 100 ignore_ctime_enabled: true is_secure_control_connection_enabled: true offset_map_enable: true per_qtree_exclude_enable: true preferred_interface_role: node_mgmt,intercluster restore_vm_cache_size: 1000 secondary_debug_filter: filter tcpnodelay: true tcpwinsize: 10000 username: user password: pass https: False ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#4b252c662a25382229272e3f2e2a266d68787c706d687e79706d687f7370252e3f2a3b3b6d687f7d70282426)> ansible netapp.ontap.na_ontap_cluster_peer – NetApp ONTAP Manage Cluster peering netapp.ontap.na\_ontap\_cluster\_peer – NetApp ONTAP Manage Cluster peering =========================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cluster_peer`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete cluster peer relations on ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| dest\_cluster\_name string \| \| The name of the destination cluster name in the peer relation to be deleted. Required for delete \| \| dest\_hostname string \| \| DEPRECATED - please use `peer_options`. Destination cluster IP or hostname which needs to be peered. Required to complete the peering process at destination cluster. \| \| dest\_intercluster\_lifs list / elements=string added in 2.8.0 of netapp.ontap \| \| List of intercluster addresses of the destination cluster. Used as peer-addresses in source cluster. All these intercluster lifs should belong to the destination cluster. aliases: dest\_intercluster\_lif \| \| dest\_password string \| \| DEPRECATED - please use `peer_options`. Destination password. Optional if this is same as source password or if a certificate is used.. \| \| dest\_username string \| \| DEPRECATED - please use `peer_options`. Destination username. Optional if this is same as source username or if a certificate is used. \| \| encryption\_protocol\_proposed string added in 20.5.0 of netapp.ontap \| Choices:* tls\_psk * none \| Encryption protocol to be used for inter-cluster communication. Only available on ONTAP 9.5 or later. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ipspace string added in 20.11.0 of netapp.ontap \| \| IPspace of the local intercluster LIFs. Assumes Default IPspace if not provided. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| passphrase string \| \| The arbitrary passphrase that matches the one given to the peer cluster. \| \| password string \| \| Password for the specified user. aliases: pass \| \| peer\_options dictionary added in 21.8.0 of netapp.ontap \| \| IP address and connection options for the peer system. If any if these options is not specified, the corresponding source option is used. \| \| \| cert\_filepath string \| \| path to SSL client cert file (.pem). \| \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| \| https boolean \| Choices:* no * yes \| Enable and disable https. \| \| \| key\_filepath string \| \| path to SSL client key file. \| \| \| ontapi integer \| \| The ontap api version to use \| \| \| password string \| \| Password for the specified user. aliases: pass \| \| \| use\_rest string \| \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| \| username string \| \| Username when using basic authentication. 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. \| \| source\_cluster\_name string \| \| The name of the source cluster name in the peer relation to be deleted. \| \| source\_intercluster\_lifs list / elements=string added in 2.8.0 of netapp.ontap \| \| List of intercluster addresses of the source cluster. Used as peer-addresses in destination cluster. All these intercluster lifs should belong to the source cluster. aliases: source\_intercluster\_lif \| \| state string \| Choices:* present ← * absent \| Whether the specified cluster peer should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create cluster peer netapp.ontap.na_ontap_cluster_peer: state: present source_intercluster_lifs: 1.2.3.4,1.2.3.5 dest_intercluster_lifs: 1.2.3.6,1.2.3.7 passphrase: XXXX hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" peer_options: hostname: "{{ dest_netapp_hostname }}" encryption_protocol_proposed: tls_psk - name: Delete cluster peer netapp.ontap.na_ontap_cluster_peer: state: absent source_cluster_name: test-source-cluster dest_cluster_name: test-dest-cluster hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" peer_options: hostname: "{{ dest_netapp_hostname }}" - name: Create cluster peer - different credentials netapp.ontap.na_ontap_cluster_peer: state: present source_intercluster_lifs: 1.2.3.4,1.2.3.5 dest_intercluster_lifs: 1.2.3.6,1.2.3.7 passphrase: XXXX hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" peer_options: hostname: "{{ dest_netapp_hostname }}" cert_filepath: "{{ cert_filepath }}" key_filepath: "{{ key_filepath }}" encryption_protocol_proposed: tls_psk ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#355b5218545b465c57595041505458131606020e131600070e1316010d0e5b5041544545131601030e565a58)> ansible netapp.ontap.na_ontap_snmp_traphosts – NetApp ONTAP SNMP traphosts. netapp.ontap.na\_ontap\_snmp\_traphosts – NetApp ONTAP SNMP traphosts. ====================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_snmp_traphosts`. New in version 20.3.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Whether the specified SNMP traphost should exist or not. Requires REST with 9.7 or higher Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ip\_address string / required \| \| The IP address of the SNMP traphost to manage. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified SNMP traphost should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create SNMP traphost na_ontap_snmp_traphosts: state: present ip_address: '10.10.10.10' hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Delete SNMP traphost na_ontap_snmp_traphosts: state: absent ip_address: '10.10.10.10' hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#d7b9b0fab6b9a4beb5bbb2a3b2b6baf1f4e4e0ecf1f4e2e5ecf1f4e3efecb9b2a3b6a7a7f1f4e3e1ecb4b8ba)>	programming_docs
ansible netapp.ontap.na_ontap_vserver_peer – NetApp ONTAP Vserver peering netapp.ontap.na\_ontap\_vserver\_peer – NetApp ONTAP Vserver peering ==================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_vserver_peer`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete vserver peer Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| applications list / elements=string \| \| List of applications which can make use of the peering relationship. FlexCache supported from ONTAP 9.5 onwards. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| dest\_hostname string \| \| DEPRECATED - please use `peer_options`. Destination hostname or IP address. Required for creating the vserver peer relationship with a remote cluster. \| \| dest\_password string \| \| DEPRECATED - please use `peer_options`. Destination password. Optional if this is same as source password. \| \| dest\_username string \| \| DEPRECATED - please use `peer_options`. Destination username. Optional if this is same as source username. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| local\_name\_for\_peer string \| \| Specifies local name of the peer Vserver in the relationship. Use this if you see "Error creating vserver peer ... Vserver name conflicts with one of the following". \| \| local\_name\_for\_source string \| \| Specifies local name of the source Vserver in the relationship. Use this if you see "Error accepting vserver peer ... System generated a name for the peer Vserver because of a naming conflict". \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| peer\_cluster string \| \| Specifies name of the peer Cluster. Required for creating the vserver peer relationship with a remote cluster \| \| peer\_options dictionary added in 21.8.0 of netapp.ontap \| \| IP address and connection options for the peer system. If any if these options is not specified, the corresponding source option is used. \| \| \| cert\_filepath string \| \| path to SSL client cert file (.pem). \| \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| \| https boolean \| Choices:* no * yes \| Enable and disable https. \| \| \| key\_filepath string \| \| path to SSL client key file. \| \| \| ontapi integer \| \| The ontap api version to use \| \| \| password string \| \| Password for the specified user. aliases: pass \| \| \| use\_rest string \| \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| \| username string \| \| Username when using basic authentication. 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. \| \| peer\_vserver string / required \| \| Specifies name of the peer Vserver in the relationship. \| \| state string \| Choices:* present ← * absent \| Whether the specified vserver peer should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies name of the source Vserver in the relationship. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Source vserver peer create netapp.ontap.na_ontap_vserver_peer: state: present peer_vserver: ansible2 peer_cluster: ansibleCluster local_name_for_peer: peername local_name_for_source: sourcename vserver: ansible applications: ['snapmirror'] hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" peer_options: hostname: "{{ netapp_dest_hostname }}" - name: vserver peer delete netapp.ontap.na_ontap_vserver_peer: state: absent peer_vserver: ansible2 vserver: ansible hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Source vserver peer create - different credentials netapp.ontap.na_ontap_vserver_peer: state: present peer_vserver: ansible2 peer_cluster: ansibleCluster local_name_for_peer: peername local_name_for_source: sourcename vserver: ansible applications: ['snapmirror'] hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" peer_options: hostname: "{{ netapp_dest_hostname }}" cert_filepath: "{{ cert_filepath }}" key_filepath: "{{ key_filepath }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#82ece5afe3ecf1ebe0eee7f6e7e3efa4a1b1b5b9a4a1b7b0b9a4a1b6bab9ece7f6e3f2f2a4a1b6b4b9e1edef)> ansible netapp.ontap.na_ontap_efficiency_policy – NetApp ONTAP manage efficiency policies (sis policies) netapp.ontap.na\_ontap\_efficiency\_policy – NetApp ONTAP manage efficiency policies (sis policies) =================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_efficiency_policy`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Modify/Delete efficiency policies (sis policies) Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| changelog\_threshold\_percent integer added in 19.11.0 of netapp.ontap \| \| Specifies the percentage at which the changelog will be processed for a threshold type of policy, tested once each hour. \| \| comment string \| \| A brief description of the policy. \| \| duration string \| \| The duration in hours for which the scheduled efficiency operation should run. After this time expires, the efficiency operation will be stopped even if the operation is incomplete. If '-' is specified as the duration, the efficiency operation will run till it completes. Otherwise, the duration has to be an integer greater than 0. By default, the operation runs till it completes. \| \| enabled boolean \| Choices:* no * yes \| If the value is true, the efficiency policy is active in this cluster. If the value is false this policy will not be activated by the schedulers and hence will be inactive. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| policy\_name string / required \| \| the name of the efficiency policy \| \| policy\_type string \| Choices:* threshold * scheduled \| The policy type reflects the reason a volume using this policy will start processing a changelog. (Changelog processing is identifying and eliminating duplicate blocks which were written since the changelog was last processed.) threshold Changelog processing occurs once the changelog reaches a certain percent full. scheduled Changelog processing will be triggered by time. \| \| qos\_policy string \| Choices:* background * best\_effort \| QoS policy for the efficiency operation. background efficiency operation will run in background with minimal or no impact on data serving client operations, best-effort efficiency operations may have some impact on data serving client operations. \| \| schedule string \| \| Cron type job schedule name. When the associated policy is set on a volume, the efficiency operation will be triggered for the volume on this schedule. These schedules can be created using the na\_ontap\_job\_schedule module \| \| state string \| Choices:* present ← * absent \| Whether the specified efficiency policy should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create threshold efficiency policy na_ontap_efficiency_policy: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" vserver: ansible state: present policy_name: test comment: This policy is for x and y enabled: true policy_type: threshold qos_policy: background changelog_threshold_percent: 20 - name: Create Scheduled efficiency Policy na_ontap_efficiency_policy: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" vserver: ansible state: present policy_name: test2 comment: This policy is for x and y enabled: true schedule: new_job_schedule duration: 1 policy_type: scheduled qos_policy: background ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#305e571d515e4359525c554455515d161303070b161305020b161304080b5e5544514040161304060b535f5d)> ansible netapp.ontap.na_ontap_disks – NetApp ONTAP Assign disks to nodes netapp.ontap.na\_ontap\_disks – NetApp ONTAP Assign disks to nodes ================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_disks`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Assign disks to a node. * Disk autoassign must be turned off before using this module to prevent the disks being reassigned automatically by the cluster. * This can be done through na\_ontap\_disk\_options or via the cli “disk option modify -node <node\_name> -autoassign off”. * If min\_spares is not specified min\_spares default is 1 if SSD or 2 for any other disk type. * If disk\_count is not specified all unassigned disks will be assigned to the node specified. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| disk\_count integer added in 2.9.0 of netapp.ontap \| \| Total number of disks a node should own. \| \| disk\_type string added in 20.6.0 of netapp.ontap \| Choices:* ATA * BSAS * FCAL * FSAS * LUN * MSATA * SAS * SSD * SSD\_NVM * VMDISK * unknown \| Assign specified type of disk (or set of disks). \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| min\_spares integer added in 21.7.0 of netapp.ontap \| \| Minimum spares required per type for the node. \| \| node string / required \| \| The node that we want to assign/unassign disks. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Assign specified total disks to node netapp.ontap.na_ontap_disks: node: node1 disk_count: 56 disk_type: VMDISK min_spares: 2 hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" - name: Assign all unassigned disks to node1 netapp.ontap.na_ontap_disks: node: node1 hostname: "{{ hostname }}" username: "{{ admin username }}" password: "{{ admin password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#204e470d414e5349424c455445414d060313171b060315121b060314181b4e4554415050060314161b434f4d)>	programming_docs
ansible netapp.ontap.na_ontap_net_routes – NetApp ONTAP network routes netapp.ontap.na\_ontap\_net\_routes – NetApp ONTAP network routes ================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_net_routes`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify ONTAP network routes. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| destination string / required \| \| Specify the route destination. Example 10.7.125.5/20, fd20:13::/64. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_destination string added in 2.8.0 of netapp.ontap \| \| Specify the route destination that should be changed. new\_destination was removed to fix idempotency issues. To rename destination the original goes to from\_destination and the new goes to destination. \| \| from\_gateway string added in 2.8.0 of netapp.ontap \| \| Specify the route gateway that should be changed. \| \| from\_metric integer added in 2.8.0 of netapp.ontap \| \| Specify the route metric that should be changed. \| \| gateway string / required \| \| Specify the route gateway. Example 10.7.125.1, fd20:13::1. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| metric integer \| \| Specify the route metric. If this field is not provided the default will be set to 20. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether you want to create or delete a network route. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create route na_ontap_net_routes: state: present vserver: "{{ Vserver name }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" destination: 10.7.125.5/20 gateway: 10.7.125.1 metric: 30 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#5f3138723e312c363d333a2b3a3e32797c6c6864797c6a6d64797c6b6764313a2b3e2f2f797c6b69643c3032)> ansible netapp.ontap.na_ontap_fpolicy_policy – NetApp ONTAP - Create, delete or modify an FPolicy policy. netapp.ontap.na\_ontap\_fpolicy\_policy – NetApp ONTAP - Create, delete or modify an FPolicy policy. ==================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fpolicy_policy`. New in version 21.3.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete or modify an FPolicy policy. Fpolicy scope must exist before running this module. * FPolicy is a file access notification framework that enables an administrator to monitor file and directory access in storage configured for CIFS and NFS. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| allow\_privileged\_access boolean \| Choices:* no * yes \| Specifies if privileged access should be given to FPolicy servers registered for the policy. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| engine string \| \| Name of the Engine. External engines must be created prior to running this task. \| \| events list / elements=string / required \| \| Events for file access monitoring. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_mandatory boolean \| Choices:* no * yes \| Specifies the action to take on a file access event in the case when all primary and secondary servers are down or no response is received from the FPolicy servers within a given timeout period. When True, file access events will be denied under these circumstances \| \| is\_passthrough\_read\_enabled boolean \| Choices:* no * yes \| Specifies if passthrough-read should be allowed to FPolicy servers registered for the policy. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Name of the policy. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| privileged\_user\_name string \| \| User name for privileged access. \| \| state string \| Choices:* present ← * absent \| Whether the fPolicy policy should exist or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| the name of the vserver to create the policy on \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create FPolicy policy na_ontap_fpolicy_policy: state: present vserver: svm1 name: fpolicy_policy events: fcpolicy_event engine: fpolicy_ext_engine username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: Modify FPolicy policy na_ontap_fpolicy_policy: state: present vserver: svm1 name: fpolicy_policy events: fcpolicy_event is_mandatory: false username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: Delete FPolicy policy na_ontap_fpolicy_policy: state: absent vserver: svm1 name: fpolicy_policy events: fcpolicy_event username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#3f5158125e514c565d535a4b5a5e52191c0c0804191c0a0d04191c0b0704515a4b5e4f4f191c0b09045c5052)> ansible netapp.ontap.na_ontap_qos_adaptive_policy_group – NetApp ONTAP Adaptive Quality of Service policy group. netapp.ontap.na\_ontap\_qos\_adaptive\_policy\_group – NetApp ONTAP Adaptive Quality of Service policy group. ============================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_qos_adaptive_policy_group`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, destroy, modify, or rename an Adaptive QoS policy group on NetApp ONTAP. Module is based on the standard QoS policy group module. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| absolute\_min\_iops string \| \| Absolute minimum IOPS defined by this policy. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| expected\_iops string \| \| Minimum expected IOPS defined by this policy. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force boolean \| Choices:* no ← * yes \| Setting to 'true' forces the deletion of the workloads associated with the policy group along with the policy group. \| \| from\_name string \| \| Name of the existing policy group to be renamed to name. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the policy group to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| peak\_iops string \| \| Maximum possible IOPS per allocated or used TB\|GB. \| \| peak\_iops\_allocation string \| Choices:* allocated\_space * used\_space ← \| Whether peak\_iops is specified by allocated or used space. \| \| state string \| Choices:* present ← * absent \| Whether the specified policy group should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create adaptive qos policy group na_ontap_qos_adaptive_policy_group: state: present name: aq_policy_1 vserver: policy_vserver absolute_min_iops: 70IOPS expected_iops: 100IOPS/TB peak_iops: 250IOPS/TB peak_iops_allocation: allocated_space hostname: 10.193.78.30 username: admin password: netapp1! - name: modify adaptive qos policy group expected iops na_ontap_qos_adaptive_policy_group: state: present name: aq_policy_1 vserver: policy_vserver absolute_min_iops: 70IOPS expected_iops: 125IOPS/TB peak_iops: 250IOPS/TB peak_iops_allocation: allocated_space hostname: 10.193.78.30 username: admin password: netapp1! - name: modify adaptive qos policy group peak iops allocation na_ontap_qos_adaptive_policy_group: state: present name: aq_policy_1 vserver: policy_vserver absolute_min_iops: 70IOPS expected_iops: 125IOPS/TB peak_iops: 250IOPS/TB peak_iops_allocation: used_space hostname: 10.193.78.30 username: admin password: netapp1! - name: delete qos policy group na_ontap_qos_adaptive_policy_group: state: absent name: aq_policy_1 vserver: policy_vserver hostname: 10.193.78.30 username: admin password: netapp1! ``` ### Authors * NetApp Ansible Team (@joshedmonds) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1d737a307c736e747f717869787c703b3e2e2a263b3e282f263b3e2925267378697c6d6d3b3e292b267e7270)> ansible netapp.ontap.na_ontap_quota_policy – NetApp Ontap create, assign, rename or delete quota policy netapp.ontap.na\_ontap\_quota\_policy – NetApp Ontap create, assign, rename or delete quota policy ================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_quota_policy`. New in version 19.11.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, assign, rename or delete the quota policy Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| auto\_assign boolean added in 20.12.0 of netapp.ontap \| Choices:* no * yes ← \| when true, assign the policy to the vserver, whether it is newly created, renamed, or already exists. when true, the policy identified by name replaces the already assigned policy. when false, the policy is created if it does not already exist but is not assigned. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string \| \| Name of the existing quota policy to be renamed to name. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies the quota policy name to create or rename to. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified quota policy should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver for the quota policy. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create quota policy na_ontap_quota_policy: state: present vserver: SVM1 name: ansible_policy hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Rename quota policy na_ontap_quota_policy: state: present vserver: SVM1 name: new_ansible from_name: ansible hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Delete quota policy na_ontap_quota_policy: state: absent vserver: SVM1 name: ansible_policy hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#59373e7438372a303b353c2d3c38347f7a6a6e627f7a6c6b627f7a6d6162373c2d3829297f7a6d6f623a3634)>	programming_docs
ansible netapp.ontap.na_ontap_quotas – NetApp ONTAP Quotas netapp.ontap.na\_ontap\_quotas – NetApp ONTAP Quotas ==================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_quotas`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Set/Modify/Delete quota on ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| activate\_quota\_on\_change string added in 20.12.0 of netapp.ontap \| Choices:* resize ← * reinitialize * none \| Method to use to activate quota on a change. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| disk\_limit string \| \| The amount of disk space that is reserved for the target. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| file\_limit string \| \| The number of files that the target can have. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| perform\_user\_mapping boolean added in 20.12.0 of netapp.ontap \| Choices:* no * yes \| Whether quota management will perform user mapping for the user specified in quota-target. User mapping can be specified only for a user quota rule. \| \| policy string \| \| Name of the quota policy from which the quota rule should be obtained. \| \| qtree string \| Default:"" \| Name of the qtree for the quota. For user or group rules, it can be the qtree name or "" if no qtree. For tree type rules, this field must be "". \| \| quota\_target string \| \| The quota target of the type specified. Required to create or modify a rule. \| \| set\_quota\_status boolean \| Choices:* no * yes \| Whether the specified volume should have quota status on or off. \| \| soft\_disk\_limit string \| \| The amount of disk space the target would have to exceed before a message is logged and an SNMP trap is generated. \| \| soft\_file\_limit string \| \| The number of files the target would have to exceed before a message is logged and an SNMP trap is generated. \| \| state string \| Choices:* present ← * absent \| Whether the specified quota should exist or not. \| \| threshold string \| \| The amount of disk space the target would have to exceed before a message is logged. \| \| type string \| Choices:* user * group * tree \| The type of quota rule Required to create or modify a rule. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volume string / required \| \| The name of the volume that the quota resides on. \| \| vserver string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Add/Set quota na_ontap_quotas: state: present vserver: ansible volume: ansible quota_target: /vol/ansible type: user policy: ansible file_limit: 2 disk_limit: 3 set_quota_status: True hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Resize quota na_ontap_quotas: state: present vserver: ansible volume: ansible quota_target: /vol/ansible type: user policy: ansible file_limit: 2 disk_limit: 3 set_quota_status: True activate_quota_on_change: resize hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Reinitialize quota na_ontap_quotas: state: present vserver: ansible volume: ansible quota_target: /vol/ansible type: user policy: ansible file_limit: 2 disk_limit: 3 set_quota_status: True activate_quota_on_change: reinitialize hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: modify quota na_ontap_quotas: state: present vserver: ansible volume: ansible quota_target: /vol/ansible type: user policy: ansible file_limit: 2 disk_limit: 3 threshold: 3 set_quota_status: False hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete quota na_ontap_quotas: state: absent vserver: ansible volume: ansible quota_target: /vol/ansible type: user policy: ansible hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#59373e7438372a303b353c2d3c38347f7a6a6e627f7a6c6b627f7a6d6162373c2d3829297f7a6d6f623a3634)> ansible netapp.ontap.na_ontap_nfs – NetApp ONTAP NFS status netapp.ontap.na\_ontap\_nfs – NetApp ONTAP NFS status ===================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_nfs`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable or disable NFS on ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| nfsv3 string \| Choices:* enabled * disabled \| status of NFSv3. \| \| nfsv3\_fsid\_change string added in 2.7.0 of netapp.ontap \| Choices:* enabled * disabled \| status of if NFSv3 clients see change in FSID as they traverse filesystems. \| \| nfsv4 string \| Choices:* enabled * disabled \| status of NFSv4. \| \| nfsv40\_acl string added in 2.7.0 of netapp.ontap \| Choices:* enabled * disabled \| status of NFS v4.0 ACL feature \| \| nfsv40\_read\_delegation string added in 2.7.0 of netapp.ontap \| Choices:* enabled * disabled \| status for NFS v4.0 read delegation feature. \| \| nfsv40\_referrals string added in 2.9.0 of netapp.ontap \| Choices:* enabled * disabled \| status for NFS v4.0 referrals. \| \| nfsv40\_write\_delegation string added in 2.7.0 of netapp.ontap \| Choices:* enabled * disabled \| status for NFS v4.0 write delegation feature. \| \| nfsv41 string \| Choices:* enabled * disabled \| status of NFSv41. aliases: nfsv4.1 \| \| nfsv41\_acl string added in 2.7.0 of netapp.ontap \| Choices:* enabled * disabled \| status of NFS v4.1 ACL feature \| \| nfsv41\_pnfs string added in 2.9.0 of netapp.ontap \| Choices:* enabled * disabled \| status of NFSv41 pNFS. \| \| nfsv41\_read\_delegation string added in 2.7.0 of netapp.ontap \| Choices:* enabled * disabled \| status for NFS v4.1 read delegation feature. \| \| nfsv41\_referrals string added in 2.9.0 of netapp.ontap \| Choices:* enabled * disabled \| status for NFS v4.1 referrals. \| \| nfsv41\_write\_delegation string added in 2.7.0 of netapp.ontap \| Choices:* enabled * disabled \| status for NFS v4.1 write delegation feature. \| \| nfsv4\_fsid\_change string added in 2.9.0 of netapp.ontap \| Choices:* enabled * disabled \| status of if NFSv4 clients see change in FSID as they traverse filesystems. \| \| nfsv4\_id\_domain string \| \| Name of the nfsv4\_id\_domain to use. \| \| nfsv4\_numeric\_ids string added in 2.9.0 of netapp.ontap \| Choices:* enabled * disabled \| status of NFSv4 numeric ID's. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| service\_state string \| Choices:* started * stopped \| Whether the specified NFS should be enabled or disabled. Creates NFS service if doesnt exist. \| \| showmount string added in 2.7.0 of netapp.ontap \| Choices:* enabled * disabled \| Whether SVM allows showmount \| \| state string \| Choices:* present ← * absent \| Whether NFS should exist or not. \| \| tcp string \| Choices:* enabled * disabled \| Enable TCP (support from ONTAP 9.3 onward). \| \| tcp\_max\_xfer\_size integer added in 2.8.0 of netapp.ontap \| \| TCP Maximum Transfer Size (bytes). The default value is 65536. \| \| udp string \| Choices:* enabled * disabled \| Enable UDP (support from ONTAP 9.3 onward). \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| \| vstorage\_state string \| Choices:* enabled * disabled \| status of vstorage\_state. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: change nfs status na_ontap_nfs: state: present service_state: stopped vserver: vs_hack nfsv3: disabled nfsv4: disabled nfsv41: enabled tcp: disabled udp: disabled vstorage_state: disabled nfsv4_id_domain: example.com hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#88e6efa5e9e6fbe1eae4edfcede9e5aeabbbbfb3aeabbdbab3aeabbcb0b3e6edfce9f8f8aeabbcbeb3ebe7e5)> ansible netapp.ontap.na_ontap_cifs_local_user_set_password – NetApp ONTAP set local CIFS user password netapp.ontap.na\_ontap\_cifs\_local\_user\_set\_password – NetApp ONTAP set local CIFS user password ==================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cifs_local_user_set_password`. New in version 21.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Sets the password for the specified local user. * NOTE - This module is not idempotent. * Password must meet the following criteria * The password must be at least six characters in length. * The password must not contain user account name. * The password must contain characters from three of the following four * English uppercase characters (A through Z) * English lowercase characters (a through z) * Base 10 digits (0 through 9) * Special characters Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| user\_name string / required \| \| The name of the local CIFS user to set the password for. \| \| user\_password string / required \| \| The password to set for the local CIFS user. \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| name of the vserver. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Set local CIFS pasword for BUILTIN Administrator account netapp.ontap.na_ontap_cifs_local_user_set_password: user_name: Administrator user_password: Test123! vserver: ansible hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#86e8e1abe7e8f5efe4eae3f2e3e7eba0a5b5b1bda0a5b3b4bda0a5b2bebde8e3f2e7f6f6a0a5b2b0bde5e9eb)>	programming_docs
ansible netapp.ontap.na_ontap_service_processor_network – NetApp ONTAP service processor network netapp.ontap.na\_ontap\_service\_processor\_network – NetApp ONTAP service processor network ============================================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_service_processor_network`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify a ONTAP service processor network Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| address\_type string / required \| Choices:* ipv4 * ipv6 \| Specify address class. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| dhcp string \| Choices:* v4 * none \| Specify dhcp type. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| gateway\_ip\_address string \| \| Specify the gateway ip. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ip\_address string \| \| Specify the service processor ip address. \| \| is\_enabled boolean / required \| Choices:* no * yes \| Specify whether to enable or disable the service processor network. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| netmask string \| \| Specify the service processor netmask. \| \| node string / required \| \| The node where the service processor network should be enabled \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| prefix\_length integer \| \| Specify the service processor prefix\_length. \| \| state string \| Choices:* present ← \| Whether the specified service processor network should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| wait\_for\_completion boolean added in 2.8.0 of netapp.ontap \| Choices:* no ← * yes \| Set this parameter to 'true' for synchronous execution (wait until SP status is successfully updated) Set this parameter to 'false' for asynchronous execution For asynchronous, execution exits as soon as the request is sent, without checking SP status \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Modify Service Processor Network na_ontap_service_processor_network: state: present address_type: ipv4 is_enabled: true dhcp: v4 node: "{{ netapp_node }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#d1bfb6fcb0bfa2b8b3bdb4a5b4b0bcf7f2e2e6eaf7f2e4e3eaf7f2e5e9eabfb4a5b0a1a1f7f2e5e7eab2bebc)> ansible netapp.ontap.na_ontap_volume_snaplock – NetApp ONTAP manage volume snaplock retention. netapp.ontap.na\_ontap\_volume\_snaplock – NetApp ONTAP manage volume snaplock retention. ========================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_volume_snaplock`. New in version 20.2.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modifies the snaplock retention of volumes on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| autocommit\_period string \| \| Specifies the autocommit-period for the snaplock volume. The format is "<number> <units>" for example "8 hours", the following units are valid seconds minutes hours days months years \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| default\_retention\_period string \| \| Specifies the default retention period that will be applied. The format is "<number> <units>" for example "10 days", the following units are valid seconds minutes hours days months years If this option is specified as "max", then maximum\_retention\_period will be used as the default retention period. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_volume\_append\_mode\_enabled boolean \| Choices:* no * yes \| Specifies if the volume append mode must be enabled or disabled. It can be modified only when the volume is not mounted and does not have any data or Snapshot copy. Volume append mode is not supported on SnapLock audit log volumes. When it is enabled, all files created with write permissions on the volume will be WORM appendable files by default. All WORM appendable files not modified for a period greater than the autocommit period of the volume are also committed to WORM read-only state. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| maximum\_retention\_period string \| \| Specifies the allowed maximum retention period that will be applied. The format is "<number> <units>" for example "2 years", the following units are valid seconds minutes hours days months years \| \| minimum\_retention\_period string \| \| Specifies the allowed minimum retention period that will be applied. The format is "<number> <units>" for example "1 days", the following units are valid seconds minutes hours days months years \| \| name string / required \| \| The name of the volume to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Set volume snaplock na_ontap_volume_snaplock: vserver: svm name: ansibleVolume default_retention_period: "5 days" minimum_retention_period: "0 years" maximum_retention_period: "10 days" is_volume_append_mode_enabled: False hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#fa949dd79b94899398969f8e9f9b97dcd9c9cdc1dcd9cfc8c1dcd9cec2c1949f8e9b8a8adcd9ceccc1999597)> ansible netapp.ontap.na_ontap_export_policy – NetApp ONTAP manage export-policy netapp.ontap.na\_ontap\_export\_policy – NetApp ONTAP manage export-policy ========================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_export_policy`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or destroy or rename export-policies on ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string added in 2.7.0 of netapp.ontap \| \| The name of the export-policy to be renamed. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the export-policy to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified export policy should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create Export Policy na_ontap_export_policy: state: present name: ansiblePolicyName vserver: vs_hack hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Rename Export Policy na_ontap_export_policy: action: present from_name: ansiblePolicyName vserver: vs_hack name: newPolicyName hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete Export Policy na_ontap_export_policy: state: absent name: ansiblePolicyName vserver: vs_hack hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#117f763c707f6278737d746574707c373222262a373224232a373225292a7f7465706161373225272a727e7c)> ansible netapp.ontap.na_ontap_wait_for_condition – NetApp ONTAP wait_for_condition. Loop over a get status request until a condition is met. netapp.ontap.na\_ontap\_wait\_for\_condition – NetApp ONTAP wait\_for\_condition. Loop over a get status request until a condition is met. ========================================================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_wait_for_condition`. New in version 20.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Loop over an ONTAP get status request until a condition is satisfied. * Report a timeout error if `timeout` is exceeded while waiting for the condition. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| attributes dictionary \| \| a dictionary of custom attributes for the event. for instance, `sp_upgrade`, `sp_version` require `node`. `sp_version` requires `expectd_version`. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| conditions list / elements=string / required \| \| one or more conditions to match for instance `is_in_progress` for `sp_upgrade`, `firmware_version` for `sp_version`. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| Choices:* sp\_upgrade * sp\_version \| The name of the event to check for. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| polling\_interval integer \| Default:5 \| how ofen to check for the conditions, in seconds. \| \| state string \| Choices:* present ← * absent \| whether the conditions should be present or absent. if `present`, the module exits when any of the conditions is observed. if `absent`, the module exits with success when None of the conditions is observed. \| \| timeout integer \| Default:180 \| how long to wait for the conditions, in seconds. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: wait for sp_upgrade in progress na_ontap_wait_for_condition: hostname: "{{ ontap_admin_ip }}" username: "{{ ontap_admin_username }}" password: "{{ ontap_admin_password }}" https: true validate_certs: no name: sp_upgrade conditions: is_in_progress attributes: node: "{{ node }}" polling_interval: 30 timeout: 1800 - name: wait for sp_upgrade not in progress na_ontap_wait_for_condition: hostname: "{{ ontap_admin_ip }}" username: "{{ ontap_admin_username }}" password: "{{ ontap_admin_password }}" https: true validate_certs: no name: sp_upgrade conditions: is_in_progress state: absent attributes: node: "{{ ontap_admin_ip }}" polling_interval: 30 timeout: 1800 - name: wait for sp_version to match 3.9 na_ontap_wait_for_condition: hostname: "{{ ontap_admin_ip }}" username: "{{ ontap_admin_username }}" password: "{{ ontap_admin_password }}" https: true validate_certs: no name: sp_version conditions: firmware_version state: present attributes: node: "{{ ontap_admin_ip }}" expected_version: 3.9 polling_interval: 30 timeout: 1800 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| last\_state string \| always \| last observed state for event \| \| states string \| always \| summarized list of observed states while waiting for completion reported for success or timeout error \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#5e3039733f302d373c323b2a3b3f33787d6d6965787d6b6c65787d6a6665303b2a3f2e2e787d6a68653d3133)>	programming_docs
ansible netapp.ontap.na_ontap_ntfs_sd – NetApp ONTAP create, delete or modify NTFS security descriptor netapp.ontap.na\_ontap\_ntfs\_sd – NetApp ONTAP create, delete or modify NTFS security descriptor ================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ntfs_sd`. New in version 20.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify or destroy NTFS security descriptor Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| control\_flags\_raw integer \| \| Specifies the security descriptor control flags. 1... .... .... .... = Self Relative .0.. .... .... .... = RM Control Valid ..0. .... .... .... = SACL Protected ...0 .... .... .... = DACL Protected .... 0... .... .... = SACL Inherited .... .0.. .... .... = DACL Inherited .... ..0. .... .... = SACL Inherit Required .... ...0 .... .... = DACL Inherit Required .... .... ..0. .... = SACL Defaulted .... .... ...0 .... = SACL Present .... .... .... 0... = DACL Defaulted .... .... .... .1.. = DACL Present .... .... .... ..0. = Group Defaulted .... .... .... ...0 = Owner Defaulted At present only the following flags are honored. Others are ignored. ..0. .... .... .... = SACL Protected ...0 .... .... .... = DACL Protected .... .... ..0. .... = SACL Defaulted .... .... .... 0... = DACL Defaulted .... .... .... ..0. = Group Defaulted .... .... .... ...0 = Owner Defaulted Convert the 16 bit binary flags and convert to decimal for the input. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| group string \| \| Specifies the group's SID or domain account of the NTFS security descriptor. Need to provide the full path of the group. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies the NTFS security descriptor name. Not modifiable. \| \| ontapi integer \| \| The ontap api version to use \| \| owner string \| \| Specifies the owner's SID or domain account of the NTFS security descriptor. Need to provide the full path of the owner. \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified NTFS security descriptor should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the vserver for the NTFS security descriptor. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create NTFS Security Descriptor na_ontap_ntfs_sd: state: present vserver: SVM1 name: ansible_sd owner: DOMAIN\Account group: DOMAIN\Group control_flags_raw: 0 hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Modify NTFS Security Descriptor na_ontap_ntfs_sd: state: present vserver: SVM1 name: ansible_sd owner: DOMAIN\Account group: DOMAIN\Group control_flags_raw: 0 hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Delete NTFS Security Descriptor na_ontap_ntfs_sd: state: absent vserver: SVM1 name: ansible_sd hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#234d440e424d504a414f465746424e050010141805001611180500171b184d46574253530500171518404c4e)> ansible netapp.ontap.na_ontap_snapmirror – NetApp ONTAP or ElementSW Manage SnapMirror netapp.ontap.na\_ontap\_snapmirror – NetApp ONTAP or ElementSW Manage SnapMirror ================================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_snapmirror`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete/Update/Initialize/Break/Resync/Resume SnapMirror volume/vserver relationships for ONTAP/ONTAP * This includes SVM replication, aka vserver DR * Create/Delete/Update/Initialize SnapMirror volume relationship between ElementSW and ONTAP * Modify schedule for a SnapMirror relationship for ONTAP/ONTAP and ElementSW/ONTAP * Pre-requisite for ElementSW to ONTAP relationship or vice-versa is an established SnapMirror endpoint for ONTAP cluster with ElementSW UI * Pre-requisite for ElementSW to ONTAP relationship or vice-versa is to have SnapMirror enabled in the ElementSW volume * For creating a SnapMirror ElementSW/ONTAP relationship, an existing ONTAP/ElementSW relationship should be present * Performs resync if the `relationship_state=active` and the current mirror state of the snapmirror relationship is broken-off * Performs resume if the `relationship_state=active`, the current snapmirror relationship status is quiesced and mirror state is snapmirrored * Performs restore if the `relationship_type=restore` and all other operations will not be performed during this task Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| connection\_type string added in 2.9.0 of netapp.ontap \| Choices:* ontap\_ontap ← * elementsw\_ontap * ontap\_elementsw \| Type of SnapMirror relationship. Pre-requisite for either elementsw\_ontap or ontap\_elementsw the ElementSW volume should have enableSnapmirror option set to true. For using ontap\_elementsw, elementsw\_ontap snapmirror relationship should exist. \| \| create\_destination dictionary added in 21.1.0 of netapp.ontap \| \| Requires ONTAP 9.7 or later. Creates the destination volume if enabled and destination\_volume is present or destination\_path includes a volume name. Creates and peers the destination vserver for SVM DR. \| \| \| enabled boolean \| Choices:* no * yes ← \| Whether to create the destination volume or vserver. This is automatically enabled if any other suboption is present. \| \| \| storage\_service dictionary \| \| storage service associated with the destination endpoint. \| \| \| \| enabled boolean \| Choices:* no * yes \| whether to create the destination endpoint using storage service. \| \| \| \| enforce\_performance boolean \| Choices:* no * yes \| whether to enforce storage service performance on the destination endpoint. \| \| \| \| name string \| Choices:* value * performance * extreme \| the performance service level (PSL) for this volume endpoint. \| \| \| tiering dictionary \| \| Cloud tiering policy. \| \| \| \| policy string \| Choices:* all * auto * none * snapshot-only \| Cloud tiering policy. \| \| \| \| supported boolean \| Choices:* no * yes \| enable provisioning of the destination endpoint volumes on FabricPool aggregates. only supported for FlexVol volume, FlexGroup volume, and Consistency Group endpoints. \| \| destination\_cluster string added in 21.1.0 of netapp.ontap \| \| Requires ONTAP 9.7 or higher. Required to create the destination vserver for SVM DR or the destination volume. Deprecated as of 21.2.0, use destination\_endpoint and cluster. \| \| destination\_endpoint dictionary added in 21.2.0 of netapp.ontap \| \| destination endpoint of a SnapMirror relationship. \| \| \| cluster string \| \| Requires ONTAP 9.7 or higher. Required to create the destination vserver for SVM DR or the destination volume. \| \| \| consistency\_group\_volumes list / elements=string \| \| Requires ONTAP 9.8 or higher. Mandatory property for a Consistency Group endpoint. Specifies the list of FlexVol volumes for a Consistency Group. \| \| \| ipspace string \| \| Requires ONTAP 9.8 or higher. Optional property to specify the IPSpace of the SVM. \| \| \| path string / required \| \| The destination endpoint for the relationship. format is <vserver:volume>, <vserver:>, <vserver:/cg/cg\_name> \| \| \| svm string \| \| The name of the SVM. Not sure when this is needed. \| \| destination\_path string \| \| Specifies the destination endpoint of the SnapMirror relationship. Deprecated as of 21.2.0, use destination\_endpoint and path. \| \| destination\_volume string \| \| Specifies the name of the destination volume for the SnapMirror. Deprecated as of 21.2.0, use source\_endpoint and path. \| \| destination\_vserver string \| \| Name of the destination vserver for the SnapMirror. Deprecated as of 21.2.0, use destination\_endpoint and path, or svm. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| identity\_preserve boolean added in 2.9.0 of netapp.ontap \| Choices:* no * yes \| Specifies whether or not the identity of the source Vserver is replicated to the destination Vserver. If this parameter is set to true, the source Vserver's configuration will additionally be replicated to the destination. If the parameter is set to false, then only the source Vserver's volumes and RBAC configuration are replicated to the destination. \| \| initialize boolean added in 19.11.0 of netapp.ontap \| Choices:* no * yes ← \| Specifies whether to initialize SnapMirror relation. Default is True, it can be explicitly set to False to avoid initializing SnapMirror relation. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| max\_transfer\_rate integer added in 2.9.0 of netapp.ontap \| \| Specifies the upper bound, in kilobytes per second, at which data is transferred. Default is unlimited, it can be explicitly set to 0 as unlimited. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| policy string added in 2.8.0 of netapp.ontap \| \| Specify the name of the SnapMirror policy that applies to this relationship. \| \| relationship\_info\_only boolean added in 20.4.0 of netapp.ontap \| Choices:* no ← * yes \| If relationship-info-only is set to true then only relationship information is removed. \| \| relationship\_state string added in 20.2.0 of netapp.ontap \| Choices:* active ← * broken \| Specifies whether to break SnapMirror relation or establish a SnapMirror relationship. state must be present to use this option. \| \| relationship\_type string \| Choices:* data\_protection * load\_sharing * vault * restore * transition\_data\_protection * extended\_data\_protection \| Specify the type of SnapMirror relationship. for 'restore' unless 'source\_snapshot' is specified the most recent Snapshot copy on the source volume is restored. restore SnapMirror is not idempotent. With REST, only 'extended\_data\_protection' is supported. ('restore' is TBD) \| \| schedule string \| \| Specify the name of the current schedule, which is used to update the SnapMirror relationship. Optional for create, modifiable. \| \| source\_cluster string added in 21.1.0 of netapp.ontap \| \| Requires ONTAP 9.7 or higher. Required to create the peering relationship between source and destination SVMs. Deprecated as of 21.2.0, use source\_endpoint and cluster. \| \| source\_endpoint dictionary added in 21.2.0 of netapp.ontap \| \| source endpoint of a SnapMirror relationship. \| \| \| cluster string \| \| Requires ONTAP 9.7 or higher. Required to create the peering relationship between source and destination SVMs. \| \| \| consistency\_group\_volumes list / elements=string \| \| Requires ONTAP 9.8 or higher. Mandatory property for a Consistency Group endpoint. Specifies the list of FlexVol volumes for a Consistency Group. \| \| \| ipspace string \| \| Requires ONTAP 9.8 or higher. Optional property to specify the IPSpace of the SVM. \| \| \| path string / required \| \| The source endpoint for the relationship. If the source is an ONTAP volume (FlexVol or FlexGroup), format should be <vserver:volume> For SVM DR, format should be <vserver:> For a consistency group, format should be <vserver:/cg/cg\_name> If the source is an ElementSW volume, format should be <Element\_SVIP:/lun/Element\_VOLUME\_ID> If the source is an ElementSW volume, the volume should have SnapMirror enabled. \| \| \| svm string \| \| The name of the SVM. Not sure when this is needed. \| \| source\_hostname string \| \| Source hostname or management IP address for ONTAP or ElementSW cluster. Required for SnapMirror delete \| \| source\_password string \| \| Source password for ONTAP or ElementSW cluster. Optional if this is same as destination password. \| \| source\_path string \| \| Specifies the source endpoint of the SnapMirror relationship. If the source is an ONTAP volume, format should be <[vserver:][volume]> or <[[cluster:]//vserver/]volume> If the source is an ElementSW volume, format should be <[Element\_SVIP]:/lun/[Element\_VOLUME\_ID]> If the source is an ElementSW volume, the volume should have SnapMirror enabled. Deprecated as of 21.2.0, use source\_endpoint and path. \| \| source\_snapshot string added in 20.6.0 of netapp.ontap \| \| Specifies the Snapshot from the source to be restored. \| \| source\_username string \| \| Source username for ONTAP or ElementSW cluster. Optional if this is same as destination username. \| \| source\_volume string \| \| Specifies the name of the source volume for the SnapMirror. Deprecated as of 21.2.0, use source\_endpoint and path. \| \| source\_vserver string \| \| Name of the source vserver for the SnapMirror. Deprecated as of 21.2.0, use source\_endpoint and path, or svm. \| \| state string \| Choices:* present ← * absent \| Whether the specified relationship should exist or not. \| \| update boolean added in 20.2.0 of netapp.ontap \| Choices:* no * yes ← \| Specifies whether to update the destination endpoint of the SnapMirror relationship only if the relationship is already present and active. Default is True. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` # creates and initializes the snapmirror - name: Create ONTAP/ONTAP SnapMirror na_ontap_snapmirror: state: present source_volume: test_src destination_volume: test_dest source_vserver: ansible_src destination_vserver: ansible_dest schedule: hourly policy: MirrorAllSnapshots max_transfer_rate: 1000 initialize: False hostname: "{{ destination_cluster_hostname }}" username: "{{ destination_cluster_username }}" password: "{{ destination_cluster_password }}" # creates and initializes the snapmirror between vservers - name: Create ONTAP/ONTAP vserver SnapMirror na_ontap_snapmirror: state: present source_vserver: ansible_src destination_vserver: ansible_dest identity_preserve: true hostname: "{{ destination_cluster_hostname }}" username: "{{ destination_cluster_username }}" password: "{{ destination_cluster_password }}" # existing snapmirror relation with status 'snapmirrored' will be initialized - name: Inititalize ONTAP/ONTAP SnapMirror na_ontap_snapmirror: state: present source_path: 'ansible:test' destination_path: 'ansible:dest' relationship_state: active hostname: "{{ destination_cluster_hostname }}" username: "{{ destination_cluster_username }}" password: "{{ destination_cluster_password }}" - name: Delete SnapMirror na_ontap_snapmirror: state: absent destination_path: <path> relationship_info_only: True source_hostname: "{{ source_hostname }}" hostname: "{{ destination_cluster_hostname }}" username: "{{ destination_cluster_username }}" password: "{{ destination_cluster_password }}" - name: Break SnapMirror na_ontap_snapmirror: state: present relationship_state: broken destination_path: <path> source_hostname: "{{ source_hostname }}" hostname: "{{ destination_cluster_hostname }}" username: "{{ destination_cluster_username }}" password: "{{ destination_cluster_password }}" - name: Restore SnapMirror volume using location (Idempotency) na_ontap_snapmirror: state: present source_path: <path> destination_path: <path> relationship_type: restore source_snapshot: "{{ snapshot }}" hostname: "{{ destination_cluster_hostname }}" username: "{{ destination_cluster_username }}" password: "{{ destination_cluster_password }}" - name: Set schedule to NULL na_ontap_snapmirror: state: present destination_path: <path> schedule: "" hostname: "{{ destination_cluster_hostname }}" username: "{{ destination_cluster_username }}" password: "{{ destination_cluster_password }}" - name: Create SnapMirror from ElementSW to ONTAP na_ontap_snapmirror: state: present connection_type: elementsw_ontap source_path: '10.10.10.10:/lun/300' destination_path: 'ansible_test:ansible_dest_vol' schedule: hourly policy: MirrorLatest hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" source_hostname: " {{ Element_cluster_mvip }}" source_username: "{{ Element_cluster_username }}" source_password: "{{ Element_cluster_password }}" - name: Create SnapMirror from ONTAP to ElementSW na_ontap_snapmirror: state: present connection_type: ontap_elementsw destination_path: '10.10.10.10:/lun/300' source_path: 'ansible_test:ansible_dest_vol' policy: MirrorLatest hostname: "{{ Element_cluster_mvip }}" username: "{{ Element_cluster_username }}" password: "{{ Element_cluster_password }}" source_hostname: " {{ netapp_hostname }}" source_username: "{{ netapp_username }}" source_password: "{{ netapp_password }}" - name: Create Snapmirror relationship (create destination volume) tags: create na_ontap_snapmirror: state: present source_endpoint: cluster: "{{ _source_cluster }}" path: "{{ source_vserver + ':' + source_volume }}" destination_endpoint: cluster: "{{ _destination_cluster }}" path: "{{ destination_vserver_VOLDP + ':' + destination_volume }}" create_destination: enabled: true hostname: "{{ destination_hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false - name: Create SnapMirror relationship - SVM DR (creating and peering destination svm) tags: create_svmdr na_ontap_snapmirror: state: present source_endpoint: cluster: "{{ _source_cluster }}" path: "{{ source_vserver + ':' }}" destination_endpoint: cluster: "{{ _destination_cluster }}" path: "{{ destination_vserver_SVMDR + ':' }}" create_destination: enabled: true hostname: "{{ destination_hostname }}" username: "{{ username }}" password: "{{ password }}" https: true validate_certs: false ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#d6b8b1fbb7b8a5bfb4bab3a2b3b7bbf0f5e5e1edf0f5e3e4edf0f5e2eeedb8b3a2b7a6a6f0f5e2e0edb5b9bb)>	programming_docs
ansible netapp.ontap.na_ontap_volume – NetApp ONTAP manage volumes. netapp.ontap.na\_ontap\_volume – NetApp ONTAP manage volumes. ============================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_volume`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or destroy or modify volumes on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| aggr\_list list / elements=string added in 2.8.0 of netapp.ontap \| \| an array of names of aggregates to be used for FlexGroup constituents. \| \| aggr\_list\_multiplier integer added in 2.8.0 of netapp.ontap \| \| The number of times to iterate over the aggregates listed with the aggr\_list parameter when creating a FlexGroup. \| \| aggregate\_name string \| \| The name of the aggregate the flexvol should exist on. Cannot be set when using the na\_application\_template option. \| \| atime\_update boolean added in 2.8.0 of netapp.ontap \| Choices:* no * yes \| This is an advanced option, the default is True. If false, prevent the update of inode access times when a file is read. This value is useful for volumes with extremely high read traffic, since it prevents writes to the inode file for the volume from contending with reads from other files. This field should be used carefully. That is, use this field when you know in advance that the correct access time for inodes will not be needed for files on that volume. \| \| auto\_provision\_as string added in 2.8.0 of netapp.ontap \| Choices:* flexgroup \| Automatically provision a FlexGroup volume. \| \| auto\_remap\_luns boolean added in 20.6.0 of netapp.ontap \| Choices:* no * yes \| Flag to control automatic map of LUNs. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| check\_interval integer added in 20.6.0 of netapp.ontap \| Default:30 \| The amount of time in seconds to wait between checks of a volume to see if it has moved successfully. \| \| comment string added in 2.9.0 of netapp.ontap \| \| Sets a comment associated with the volume. \| \| compression boolean added in 20.12.0 of netapp.ontap \| Choices:* no * yes \| Whether to enable compression for the volume (HDD and Flash Pool aggregates). If this option is not present, it is automatically set to true if inline\_compression is true. \| \| cutover\_action string added in 20.5.0 of netapp.ontap \| Choices:* abort\_on\_failure * defer\_on\_failure * force * wait \| Specifies the action to be taken for cutover. Possible values are 'abort\_on\_failure', 'defer\_on\_failure', 'force' and 'wait'. Default is 'defer\_on\_failure'. \| \| efficiency\_policy string added in 2.7.0 of netapp.ontap \| \| Allows a storage efficiency policy to be set on volume creation. \| \| encrypt boolean added in 2.7.0 of netapp.ontap \| Choices:* no * yes \| Whether or not to enable Volume Encryption. If not present, ONTAP defaults to false at volume creation. Changing encrypt value after creation requires ONTAP 9.3 or later. \| \| export\_policy string \| \| Name of the export policy. Mutually exclusive with nfs\_access suboption in nas\_application\_template. aliases: policy \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force\_restore boolean added in 20.6.0 of netapp.ontap \| Choices:* no * yes \| If this field is set to "true", the Snapshot copy is restored even if the volume has one or more newer Snapshot copies which are currently used as reference Snapshot copy by SnapMirror. If a restore is done in this situation, this will cause future SnapMirror transfers to fail. Option should only be used along with snapshot\_restore. \| \| force\_unmap\_luns boolean added in 20.6.0 of netapp.ontap \| Choices:* no * yes \| Flag to control automatic unmap of LUNs. \| \| from\_name string added in 2.7.0 of netapp.ontap \| \| Name of the existing volume to be renamed to name. \| \| from\_vserver string added in 20.6.0 of netapp.ontap \| \| The source vserver of the volume is rehosted. \| \| group\_id integer added in 20.1.0 of netapp.ontap \| \| The UNIX group ID for the volume. The default value is 0 ('root'). \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| inline\_compression boolean added in 20.12.0 of netapp.ontap \| Choices:* no * yes \| Whether to enable inline compression for the volume (HDD and Flash Pool aggregates, AFF platforms). \| \| is\_infinite boolean \| Choices:* no ← * yes \| Set True if the volume is an Infinite Volume. Deleting an infinite volume is asynchronous. \| \| is\_online boolean \| Choices:* no * yes ← \| Whether the specified volume is online, or not. \| \| junction\_path string \| \| Junction path of the volume. To unmount, use junction path `''`. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| language string added in 2.8.0 of netapp.ontap \| \| Language to use for Volume Default uses SVM language Possible values Language c POSIX ar Arabic cs Czech da Danish de German en English en\_us English (US) es Spanish fi Finnish fr French he Hebrew hr Croatian hu Hungarian it Italian ja Japanese euc-j ja\_v1 Japanese euc-j ja\_jp.pck Japanese PCK (sjis) ja\_jp.932 Japanese cp932 ja\_jp.pck\_v2 Japanese PCK (sjis) ko Korean no Norwegian nl Dutch pl Polish pt Portuguese ro Romanian ru Russian sk Slovak sl Slovenian sv Swedish tr Turkish zh Simplified Chinese zh.gbk Simplified Chinese (GBK) zh\_tw Traditional Chinese euc-tw zh\_tw.big5 Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append '.UTF-8' to the language code \| \| name string / required \| \| The name of the volume to manage. \| \| nas\_application\_template dictionary added in 20.12.0 of netapp.ontap \| \| additional options when using the application/applications REST API to create a volume. the module is using ZAPI by default, and switches to REST if any suboption is present. create a FlexVol by default. create a FlexGroup if `auto_provision_as` is set and `FlexCache` option is not present. create a FlexCache if `flexcache` option is present. \| \| \| cifs\_access list / elements=dictionary \| \| The list of CIFS access controls. You must provide user\_or\_group or access to enable CIFS access. \| \| \| \| access string \| Choices:* change * full\_control * no\_access * read \| The CIFS access granted to the user or group. Default is full\_control. \| \| \| \| user\_or\_group string \| \| The name of the CIFS user or group that will be granted access. Default is Everyone. \| \| \| exclude\_aggregates list / elements=string added in 21.7.0 of netapp.ontap \| \| The list of aggregate names to exclude when creating a volume. Requires ONTAP 9.9.1 GA or later. \| \| \| flexcache dictionary \| \| whether to create a flexcache. If absent, a FlexVol or FlexGroup is created. \| \| \| \| dr\_cache boolean added in 21.3.0 of netapp.ontap \| Choices:* no * yes \| whether to use the same flexgroup msid as the origin. requires ONTAP 9.9 and REST. create only option, ignored if the flexcache already exists. \| \| \| \| origin\_component\_name string / required \| \| the remote component for the flexcache. \| \| \| \| origin\_svm\_name string / required \| \| the remote SVM for the flexcache. \| \| \| nfs\_access list / elements=dictionary \| \| The list of NFS access controls. You must provide host or access to enable NFS access. Mutually exclusive with export\_policy option in nas\_application\_template. \| \| \| \| access string \| Choices:* none * ro * rw \| The NFS access granted. Default is rw. \| \| \| \| host string \| \| The name of the NFS entity granted access. Default is 0.0.0.0/0. \| \| \| storage\_service string \| Choices:* value * performance * extreme \| The performance service level (PSL) for this volume \| \| \| tiering dictionary \| \| Cloud tiering policy (see `tiering_policy` for a more complete description). \| \| \| \| control string \| Choices:* required * best\_effort * disallowed \| Storage tiering placement rules for the container. \| \| \| \| object\_stores list / elements=string \| \| list of object store names for tiering. \| \| \| \| policy string \| Choices:* all * auto * none * snapshot-only \| Cloud tiering policy (see `tiering_policy`). Must match `tiering_policy` if both are present. \| \| \| use\_nas\_application boolean \| Choices:* no * yes ← \| Whether to use the application/applications REST/API to create a volume. This will default to true if any other suboption is present. \| \| nvfail\_enabled boolean added in 2.9.0 of netapp.ontap \| Choices:* no * yes \| If true, the controller performs additional work at boot and takeover times if it finds that there has been any potential data loss in the volume's constituents due to an NVRAM failure. The volume's constituents would be put in a special state called 'in-nvfailed-state' such that protocol access is blocked. This will cause the client applications to crash and thus prevent access to stale data. To get out of this situation, the admin needs to manually clear the 'in-nvfailed-state' on the volume's constituents. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| percent\_snapshot\_space integer \| \| Amount of space reserved for snapshot copies of the volume. \| \| preserve\_lun\_ids boolean added in 20.6.0 of netapp.ontap \| Choices:* no * yes \| If this field is set to "true", LUNs in the volume being restored will remain mapped and their identities preserved such that host connectivity will not be disrupted during the restore operation. I/O's to the LUN will be fenced during the restore operation by placing the LUNs in an unavailable state. Once the restore operation has completed, hosts will be able to resume I/O access to the LUNs. Option should only be used along with snapshot\_restore. \| \| qos\_adaptive\_policy\_group string added in 2.9.0 of netapp.ontap \| \| Specifies a QoS adaptive policy group to be set on volume. \| \| qos\_policy\_group string added in 2.9.0 of netapp.ontap \| \| Specifies a QoS policy group to be set on volume. \| \| size integer \| \| The size of the volume in (size\_unit). Required when `state=present`. \| \| size\_change\_threshold integer added in 20.12.0 of netapp.ontap \| Default:10 \| Percentage in size change to trigger a resize. When this parameter is greater than 0, a difference in size between what is expected and what is configured is ignored if it is below the threshold. For instance, the nas application allocates a larger size than specified to account for overhead. Set this to 0 for an exact match. \| \| size\_unit string \| Choices:* bytes * b * kb * mb * gb ← * tb * pb * eb * zb * yb \| The unit used to interpret the size parameter. \| \| sizing\_method string added in 20.12.0 of netapp.ontap \| Choices:* add\_new\_resources * use\_existing\_resources \| Represents the method to modify the size of a FlexGroup. use\_existing\_resources - Increases or decreases the size of the FlexGroup by increasing or decreasing the size of the current FlexGroup resources. add\_new\_resources - Increases the size of the FlexGroup by adding new resources. This is limited to two new resources per available aggregate. This is only supported if REST is enabled (ONTAP 9.6 or later) and only for FlexGroups. ONTAP defaults to use\_existing\_resources. \| \| snapdir\_access boolean added in 2.8.0 of netapp.ontap \| Choices:* no * yes \| This is an advanced option, the default is False. Enable the visible '.snapshot' directory that is normally present at system internal mount points. This value also turns on access to all other '.snapshot' directories in the volume. \| \| snapshot\_auto\_delete dictionary added in 20.4.0 of netapp.ontap \| \| A dictionary for the auto delete options and values. Supported options include 'state', 'commitment', 'trigger', 'target\_free\_space', 'delete\_order', 'defer\_delete', 'prefix', 'destroy\_list'. Option 'state' determines if the snapshot autodelete is currently enabled for the volume. Possible values are 'on' and 'off'. Option 'commitment' determines the snapshots which snapshot autodelete is allowed to delete to get back space. Possible values are 'try', 'disrupt' and 'destroy'. Option 'trigger' determines the condition which starts the automatic deletion of snapshots. Possible values are 'volume', 'snap\_reserve' and DEPRECATED 'space\_reserve'. Option 'target\_free\_space' determines when snapshot autodelete should stop deleting snapshots. Depending on the trigger, snapshots are deleted till we reach the target free space percentage. Accepts int type. Option 'delete\_order' determines if the oldest or newest snapshot is deleted first. Possible values are 'newest\_first' and 'oldest\_first'. Option 'defer\_delete' determines which kind of snapshots to delete in the end. Possible values are 'scheduled', 'user\_created', 'prefix' and 'none'. Option 'prefix' can be set to provide the prefix string for the 'prefix' value of the 'defer\_delete' option. The prefix string length can be 15 char long. Option 'destroy\_list' is a comma seperated list of services which can be destroyed if the snapshot backing that service is deleted. For 7-mode, the possible values for this option are a combination of 'lun\_clone', 'vol\_clone', 'cifs\_share', 'file\_clone' or 'none'. For cluster-mode, the possible values for this option are a combination of 'lun\_clone,file\_clone' (for LUN clone and/or file clone), 'lun\_clone,sfsr' (for LUN clone and/or sfsr), 'vol\_clone', 'cifs\_share', or 'none'. \| \| snapshot\_policy string added in 2.8.0 of netapp.ontap \| \| The name of the snapshot policy. The default policy name is 'default'. If present, this will set the protection\_type when using `nas_application_template`. \| \| snapshot\_restore string added in 20.6.0 of netapp.ontap \| \| Name of snapshot to restore from. Not supported on Infinite Volume. \| \| space\_guarantee string \| Choices:* none * file * volume \| Space guarantee style for the volume. \| \| space\_slo string added in 2.9.0 of netapp.ontap \| Choices:* none * thick * semi-thick \| Specifies the space SLO type for the volume. The space SLO type is the Service Level Objective for space management for the volume. The space SLO value is used to enforce existing volume settings so that sufficient space is set aside on the aggregate to meet the space SLO. This parameter is not supported on Infinite Volumes. \| \| state string \| Choices:* present ← * absent \| Whether the specified volume should exist or not. \| \| tiering\_policy string added in 2.9.0 of netapp.ontap \| Choices:* snapshot-only * auto * backup * none * all \| The tiering policy that is to be associated with the volume. This policy decides whether the blocks of a volume will be tiered to the capacity tier. snapshot-only policy allows tiering of only the volume snapshot copies not associated with the active file system. auto policy allows tiering of both snapshot and active file system user data to the capacity tier. backup policy on DP volumes allows all transferred user data blocks to start in the capacity tier. all is the REST equivalent for backup. When set to none, the Volume blocks will not be tiered to the capacity tier. If no value specified, the volume is assigned snapshot only by default. Requires ONTAP 9.4 or later. \| \| time\_out integer added in 2.8.0 of netapp.ontap \| Default:180 \| time to wait for Flexgroup creation, modification, or deletion in seconds. Error out if task is not completed in defined time. if 0, the request is asynchronous. default is set to 3 minutes. \| \| type string \| \| The volume type, either read-write (RW) or data-protection (DP). \| \| unix\_permissions string added in 2.8.0 of netapp.ontap \| \| Unix permission bits in octal or symbolic format. For example, 0 is equivalent to ------------, 777 is equivalent to ---rwxrwxrwx,both formats are accepted. The valid octal value ranges between 0 and 777 inclusive. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| user\_id integer added in 20.1.0 of netapp.ontap \| \| The UNIX user ID for the volume. The default value is 0 ('root'). \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volume\_security\_style string \| Choices:* mixed * ntfs * unified * unix \| The security style associated with this volume. \| \| vserver string / required \| \| Name of the vserver to use. \| \| vserver\_dr\_protection string added in 2.9.0 of netapp.ontap \| Choices:* protected * unprotected \| Specifies the protection type for the volume in a Vserver DR setup. \| \| wait\_for\_completion boolean added in 2.8.0 of netapp.ontap \| Choices:* no ← * yes \| Set this parameter to 'true' for synchronous execution during create (wait until volume status is online) Set this parameter to 'false' for asynchronous execution For asynchronous, execution exits as soon as the request is sent, without checking volume status \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create FlexVol na_ontap_volume: state: present name: ansibleVolume12 is_infinite: False aggregate_name: ansible_aggr size: 100 size_unit: mb user_id: 1001 group_id: 2002 space_guarantee: none tiering_policy: auto export_policy: default percent_snapshot_space: 60 qos_policy_group: max_performance_gold vserver: ansibleVServer wait_for_completion: True space_slo: none nvfail_enabled: False comment: ansible created volume hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Volume Delete na_ontap_volume: state: absent name: ansibleVolume12 aggregate_name: ansible_aggr vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Make FlexVol offline na_ontap_volume: state: present name: ansibleVolume is_infinite: False is_online: False vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create Flexgroup volume manually na_ontap_volume: state: present name: ansibleVolume is_infinite: False aggr_list: "{{ aggr_list }}" aggr_list_multiplier: 2 size: 200 size_unit: mb space_guarantee: none export_policy: default vserver: "{{ vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: False unix_permissions: 777 snapshot_policy: default time_out: 0 - name: Create Flexgroup volume auto provsion as flex group na_ontap_volume: state: present name: ansibleVolume is_infinite: False auto_provision_as: flexgroup size: 200 size_unit: mb space_guarantee: none export_policy: default vserver: "{{ vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: False unix_permissions: 777 snapshot_policy: default time_out: 0 - name: Create FlexVol with QoS adaptive na_ontap_volume: state: present name: ansibleVolume15 is_infinite: False aggregate_name: ansible_aggr size: 100 size_unit: gb space_guarantee: none export_policy: default percent_snapshot_space: 10 qos_adaptive_policy_group: extreme vserver: ansibleVServer wait_for_completion: True hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify volume dr protection (vserver of the volume must be in a snapmirror relationship) na_ontap_volume: state: present name: ansibleVolume vserver_dr_protection: protected vserver: "{{ vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: False - name: Modify volume with snapshot auto delete options na_ontap_volume: state: present name: vol_auto_delete snapshot_auto_delete: state: "on" commitment: try defer_delete: scheduled target_free_space: 30 destroy_list: lun_clone,vol_clone delete_order: newest_first aggregate_name: "{{ aggr }}" vserver: "{{ vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: False - name: Move volume with force cutover action na_ontap_volume: name: ansible_vol aggregate_name: aggr_ansible cutover_action: force vserver: "{{ vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: false - name: Rehost volume to another vserver auto remap luns na_ontap_volume: name: ansible_vol from_vserver: ansible auto_remap_luns: true vserver: "{{ vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: false - name: Rehost volume to another vserver force unmap luns na_ontap_volume: name: ansible_vol from_vserver: ansible force_unmap_luns: true vserver: "{{ vserver }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: false - name: Snapshot restore volume na_ontap_volume: name: ansible_vol vserver: ansible snapshot_restore: 2020-05-24-weekly force_restore: true preserve_lun_ids: true hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: true validate_certs: false - name: Volume create using application/applications nas template na_ontap_volume: state: present name: ansibleVolume12 vserver: ansibleSVM size: 100000000 size_unit: b space_guarantee: none language: es percent_snapshot_space: 60 unix_permissions: ---rwxrwxrwx snapshot_policy: default efficiency_policy: default comment: testing nas_application_template: nfs_access: # the mere presence of a suboption is enough to enable this new feature - access: ro - access: rw host: 10.0.0.0/8 exclude_aggregates: aggr0 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" https: true validate_certs: false ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#87e9e0aae6e9f4eee5ebe2f3e2e6eaa1a4b4b0bca1a4b2b5bca1a4b3bfbce9e2f3e6f7f7a1a4b3b1bce4e8ea)>	programming_docs
ansible netapp.ontap.na_ontap_ntp – NetApp ONTAP NTP server netapp.ontap.na\_ontap\_ntp – NetApp ONTAP NTP server ===================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ntp`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or delete or modify NTP server in ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| server\_name string / required \| \| The name of the NTP server to manage. \| \| state string \| Choices:* present ← * absent \| Whether the specified NTP server should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| version string \| Choices:* auto ← * 3 * 4 \| give version for NTP server \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create NTP server na_ontap_ntp: state: present version: auto server_name: "{{ server_name }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete NTP server na_ontap_ntp: state: absent server_name: "{{ server_name }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#68060f4509061b010a040d1c0d09054e4b5b5f534e4b5d5a534e4b5c5053060d1c0918184e4b5c5e530b0705)> ansible netapp.ontap.na_ontap_user – NetApp ONTAP user configuration and management netapp.ontap.na\_ontap\_user – NetApp ONTAP user configuration and management ============================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_user`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or destroy users. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| application\_dicts list / elements=dictionary added in 21.6.0 of netapp.ontap \| \| List of applications to grant access to. Provides better control on applications and authentication methods. Creating a login with application console, telnet, rsh, and service-processor for a data vserver is not supported. Module supports both service-processor and service\_processor choices. ZAPI requires service-processor, while REST requires service\_processor, except for an issue with ONTAP 9.6 and 9.7. snmp is not supported in REST. Either `application_dicts` or `application_strs` is required. \| \| \| application string / required \| Choices:* console * http * ontapi * rsh * snmp * service\_processor * service-processor * sp * ssh * telnet \| name of the application. \| \| \| authentication\_methods list / elements=string / required \| Choices:* community * password * publickey * domain * nsswitch * usm * cert \| list of authentication methods for the application. \| \| \| second\_authentication\_method string \| Choices:* none * password * publickey * nsswitch \| when using ssh, optional additional authentication method for MFA. \| \| application\_strs list / elements=string added in 21.6.0 of netapp.ontap \| Choices:* console * http * ontapi * rsh * snmp * service\_processor * service-processor * sp * ssh * telnet \| List of applications to grant access to. This option maintains backward compatibility with the existing `applications` option, but is limited. It is recommended to use the new `application_dicts` option which provides more flexibility. Creating a login with application console, telnet, rsh, and service-processor for a data vserver is not supported. Module supports both service-processor and service\_processor choices. ZAPI requires service-processor, while REST requires service\_processor, except for an issue with ONTAP 9.6 and 9.7. snmp is not supported in REST. Either `application_dicts` or `application_strs` is required. aliases: application, applications \| \| authentication\_method string \| Choices:* community * password * publickey * domain * nsswitch * usm * cert \| Authentication method for the application. If you need more than one method, use `application_dicts`. Not all authentication methods are valid for an application. Valid authentication methods for each application are as denoted in authentication\_choices\_description. Password for console application Password, domain, nsswitch, cert for http application. Password, domain, nsswitch, cert for ontapi application. Community for snmp application (when creating SNMPv1 and SNMPv2 users). The usm and community for snmp application (when creating SNMPv3 users). Password for sp application. Password for rsh application. Password for telnet application. Password, publickey, domain, nsswitch for ssh application. Required when `application_strs` is present. \| \| authentication\_password string added in 20.6.0 of netapp.ontap \| \| Password for the authentication protocol. This should be minimum 8 characters long. This is required for 'md5', 'sha' and 'sha2-256' authentication protocols and not required for 'none'. Only available for 'usm' authentication method and non modifiable. \| \| authentication\_protocol string added in 20.6.0 of netapp.ontap \| Choices:* none * md5 * sha * sha2-256 \| Authentication protocol for the snmp user. When cluster FIPS mode is on, 'sha' and 'sha2-256' are the only possible and valid values. When cluster FIPS mode is off, the default value is 'none'. When cluster FIPS mode is on, the default value is 'sha'. Only available for 'usm' authentication method and non modifiable. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| engine\_id string added in 20.6.0 of netapp.ontap \| \| Authoritative entity's EngineID for the SNMPv3 user. This should be specified as a hexadecimal string. Engine ID with first bit set to 1 in first octet should have a minimum of 5 or maximum of 32 octets. Engine Id with first bit set to 0 in the first octet should be 12 octets in length. Engine Id cannot have all zeros in its address. Only available for 'usm' authentication method and non modifiable. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| lock\_user boolean \| Choices:* no * yes \| Whether the specified user account is locked. \| \| name string / required \| \| The name of the user to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| privacy\_password string added in 20.6.0 of netapp.ontap \| \| Password for the privacy protocol. This should be minimum 8 characters long. This is required for 'des' and 'aes128' privacy protocols and not required for 'none'. Only available for 'usm' authentication method and non modifiable. \| \| privacy\_protocol string added in 20.6.0 of netapp.ontap \| Choices:* none * des * aes128 \| Privacy protocol for the snmp user. When cluster FIPS mode is on, 'aes128' is the only possible and valid value. When cluster FIPS mode is off, the default value is 'none'. When cluster FIPS mode is on, the default value is 'aes128'. Only available for 'usm' authentication method and non modifiable. \| \| remote\_switch\_ipaddress string added in 20.6.0 of netapp.ontap \| \| This optionally specifies the IP Address of the remote switch. The remote switch could be a cluster switch monitored by Cluster Switch Health Monitor (CSHM) or a Fiber Channel (FC) switch monitored by Metro Cluster Health Monitor (MCC-HM). This is applicable only for a remote SNMPv3 user i.e. only if user is a remote (non-local) user, application is snmp and authentication method is usm. \| \| replace\_existing\_apps\_and\_methods string added in 20.6.0 of netapp.ontap \| Choices:* always * auto ← \| If the user already exists, the current applications and authentications methods are replaced when state=present. If the user already exists, the current applications and authentications methods are removed when state=absent. When using application\_dicts or REST, this the only supported behavior. When using application\_strs and ZAPI, this is the behavior when this option is set to always. When using application\_strs and ZAPI, if the option is set to auto, applications that are not listed are not removed. When using application\_strs and ZAPI, if the option is set to auto, authentication mehods that are not listed are not removed. `auto` preserve the existing behavior for backward compatibility, but note that REST and ZAPI have inconsistent behavior. This is another reason to recommend to use `application_dicts`. \| \| role\_name string \| \| The name of the role. Required when `state=present` \| \| set\_password string \| \| Password for the user account. It is ignored for creating snmp users, but is required for creating non-snmp users. For an existing user, this value will be used as the new password. \| \| state string \| Choices:* present ← * absent \| Whether the specified user should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. With REST, for cluster scope, use a vserver entry with no value. aliases: svm \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create User netapp.ontap.na_ontap_user: state: present name: SampleUser applications: ssh,console authentication_method: password set_password: apn1242183u1298u41 lock_user: True role_name: vsadmin vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete User netapp.ontap.na_ontap_user: state: absent name: SampleUser applications: ssh authentication_method: password vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create user with snmp application (ZAPI) netapp.ontap.na_ontap_user: state: present name: test_cert_snmp applications: snmp authentication_method: usm role_name: admin authentication_protocol: md5 authentication_password: '12345678' privacy_protocol: 'aes128' privacy_password: '12345678' engine_id: '7063514941000000000000' remote_switch_ipaddress: 10.0.0.0 vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Create user netapp.ontap.na_ontap_user: state: present name: test123 application_dicts: - application: http authentication_methods: password - application: ssh authentication_methods: password,publickey role_name: vsadmin set_password: bobdole1234566 vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#8be5eca6eae5f8e2e9e7eeffeeeae6ada8b8bcb0ada8beb9b0ada8bfb3b0e5eeffeafbfbada8bfbdb0e8e4e6)> ansible netapp.ontap.na_ontap_interface – NetApp ONTAP LIF configuration netapp.ontap.na\_ontap\_interface – NetApp ONTAP LIF configuration ================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_interface`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Creating / deleting and modifying the LIF. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| address string \| \| Specifies the LIF's IP address. Required when `state=present` and is\_ipv4\_link\_local if false and subnet\_name is not set. \| \| admin\_status string \| Choices:* up * down \| Specifies the administrative status of the LIF. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| current\_node string \| \| Specifies the LIF's current node. By default, this is home\_node \| \| current\_port string \| \| Specifies the LIF's current port. \| \| dns\_domain\_name string added in 2.9.0 of netapp.ontap \| \| Specifies the unique, fully qualified domain name of the DNS zone of this LIF. \| \| failover\_group string added in 20.1.0 of netapp.ontap \| \| Specifies the failover group for the LIF. \| \| failover\_policy string \| Choices:* disabled * system-defined * local-only * sfo-partner-only * broadcast-domain-wide \| Specifies the failover policy for the LIF. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| firewall\_policy string \| \| Specifies the firewall policy for the LIF. \| \| force\_subnet\_association boolean added in 2.9.0 of netapp.ontap \| Choices:* no * yes \| Set this to true to acquire the address from the named subnet and assign the subnet to the LIF. \| \| from\_name string added in 21.11.0 of netapp.ontap \| \| name of the interface to be renamed \| \| home\_node string \| \| Specifies the LIF's home node. By default, the first node from the cluster is considered as home node \| \| home\_port string \| \| Specifies the LIF's home port. Required when `state=present` \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| interface\_name string / required \| \| Specifies the logical interface (LIF) name. \| \| is\_auto\_revert boolean \| Choices:* no * yes \| If true, data LIF will revert to its home node under certain circumstances such as startup, and load balancing migration capability is disabled automatically \| \| is\_dns\_update\_enabled boolean added in 2.9.0 of netapp.ontap \| Choices:* no * yes \| Specifies if DNS update is enabled for this LIF. Dynamic updates will be sent for this LIF if updates are enabled at Vserver level. \| \| is\_ipv4\_link\_local boolean added in 20.1.0 of netapp.ontap \| Choices:* no * yes \| Specifies the LIF's are to acquire a ipv4 link local address. Use case for this is when creating Cluster LIFs to allow for auto assignment of ipv4 link local address. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| listen\_for\_dns\_query boolean added in 2.9.0 of netapp.ontap \| Choices:* no * yes \| If True, this IP address will listen for DNS queries for the dnszone specified. \| \| netmask string \| \| Specifies the LIF's netmask. Required when `state=present` and is\_ipv4\_link\_local if false and subnet\_name is not set. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| protocols list / elements=string \| \| Specifies the list of data protocols configured on the LIF. By default, the values in this element are nfs, cifs and fcache. Other supported protocols are iscsi and fcp. A LIF can be configured to not support any data protocols by specifying 'none'. Protocol values of none, iscsi, fc-nvme or fcp can't be combined with any other data protocol(s). address, netmask and firewall\_policy parameters are not supported for 'fc-nvme' option. \| \| role string \| \| Specifies the role of the LIF. When setting role as "intercluster" or "cluster", setting protocol is not supported. When creating a "cluster" role, the node name will appear as the prefix in the name of LIF. For example, if the specified name is clif and node name is node1, the LIF name appears in the ONTAP as node1\_clif. Possible values are 'undef', 'cluster', 'data', 'node-mgmt', 'intercluster', 'cluster-mgmt'. Required when `state=present` unless service\_policy is present and ONTAP version is 9.8 or better. \| \| service\_policy string added in 20.4.0 of netapp.ontap \| \| Starting with ONTAP 9.5, you can configure LIF service policies to identify a single service or a list of services that will use a LIF. In ONTAP 9.5, you can assign service policies only for LIFs in the admin SVM. In ONTAP 9.6, you can additionally assign service policies for LIFs in the data SVMs. When you specify a service policy for a LIF, you need not specify the data protocol and role for the LIF. NOTE that role is still required because of a ZAPI issue. This limitation is removed in ONTAP 9.8. Creating LIFs by specifying the role and data protocols is also supported. \| \| state string \| Choices:* present ← * absent \| Whether the specified interface should exist or not. \| \| subnet\_name string added in 2.8.0 of netapp.ontap \| \| Subnet where the interface address is allocated from. If the option is not used, the IP address will need to be provided by the administrator during configuration. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create interface netapp.ontap.na_ontap_interface: state: present interface_name: data2 home_port: e0d home_node: laurentn-vsim1 role: data protocols: - nfs - cifs admin_status: up failover_policy: local-only firewall_policy: mgmt is_auto_revert: true address: 10.10.10.10 netmask: 255.255.255.0 force_subnet_association: false dns_domain_name: test.com listen_for_dns_query: true is_dns_update_enabled: true vserver: svm1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create cluster interface netapp.ontap.na_ontap_interface: state: present interface_name: cluster_lif home_port: e0a home_node: cluster1-01 role: cluster admin_status: up is_auto_revert: true is_ipv4_link_local: true vserver: Cluster hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Rename interface netapp.ontap.na_ontap_interface: state: present from_name: ansibleSVM_lif interface_name: ansibleSVM_lif01 vserver: ansibleSVM hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Migrate an interface na_ontap_interface: hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" vserver: ansible https: true validate_certs: false state: present interface_name: carchi_interface3 home_port: e0d home_node: ansdev-stor-1 current_node: ansdev-stor-2 role: data failover_policy: local-only firewall_policy: mgmt is_auto_revert: true address: 10.10.10.12 netmask: 255.255.255.0 force_subnet_association: false admin_status: up - name: Delete interface na_ontap_interface: state: absent interface_name: data2 vserver: svm1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#86e8e1abe7e8f5efe4eae3f2e3e7eba0a5b5b1bda0a5b3b4bda0a5b2bebde8e3f2e7f6f6a0a5b2b0bde5e9eb)>	programming_docs
ansible netapp.ontap.na_ontap_storage_failover – Enables or disables NetApp Ontap storage failover for a specified node netapp.ontap.na\_ontap\_storage\_failover – Enables or disables NetApp Ontap storage failover for a specified node ================================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_storage_failover`. New in version 21.3.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable or disable storage failover Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| node\_name string / required \| \| Specifies the node name to enable or disable storage failover. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether storage failover should be enabled (present) or disabled (absent). \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Enable storage failover na_ontap_storage_failover: state: present node_name: node1 hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Disable storage failover na_ontap_storage_failover: state: absent node_name: node1 hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#cba5ace6aaa5b8a2a9a7aebfaeaaa6ede8f8fcf0ede8fef9f0ede8fff3f0a5aebfaabbbbede8fffdf0a8a4a6)> ansible netapp.ontap.na_ontap_node – NetApp ONTAP Modify or Rename a node. netapp.ontap.na\_ontap\_node – NetApp ONTAP Modify or Rename a node. ==================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_node`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify or Rename an ONTAP node. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| asset\_tag string \| \| The asset tag for the node, not supported by REST \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| from\_name string \| \| The name of the node to be renamed. If name already exists, no action will be performed. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| location string \| \| The location for the node \| \| name string / required \| \| The name for the node \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: modify node na_ontap_node: name: laurentncluster-2 location: SF1 asset_tag: mytag hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: rename node na_ontap_node: hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" from_name: laurentn-vsim1 name: laurentncluster-2 - name: modify and rename node na_ontap_node: hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" location: SF2 from_name: laurentn-vsim1 name: laurentncluster-2 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c0aea7eda1aeb3a9a2aca5b4a5a1ade6e3f3f7fbe6e3f5f2fbe6e3f4f8fbaea5b4a1b0b0e6e3f4f6fba3afad)> ansible netapp.ontap.na_ontap_security_config – NetApp ONTAP modify security config for SSL. netapp.ontap.na\_ontap\_security\_config – NetApp ONTAP modify security config for SSL. ======================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_security_config`. New in version 21.3.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modifies the security configuration for SSL. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_fips\_enabled boolean \| Choices:* no * yes \| Enables or disables FIPS-compliant mode for the cluster. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string \| Default:"ssl" \| The type of FIPS compliant interface. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| supported\_ciphers string \| \| Selects the supported cipher suites for the selected interface. \| \| supported\_protocols list / elements=string \| Choices:* TLSv1.2 * TLSv1.1 * TLSv1 \| Selects the supported protocols for the selected interface. Supported\_ciphers should not be specified if operating in FIPS-compliant mode. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Modify SSL Security Config na_ontap_security_config: name: ssl is_fips_enabled: false supported_ciphers: 'ALL:!LOW:!aNULL:!EXP:!eNULL:!3DES:!RC4:!SHA1' supported_protocols: ['TLSv1.2', 'TLSv1.1', 'TLSv1'] hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ontapi: "{{ ontap_info.ontap_info.ontap_version }}" https: true validate_certs: false ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#80eee7ade1eef3e9e2ece5f4e5e1eda6a3b3b7bba6a3b5b2bba6a3b4b8bbeee5f4e1f0f0a6a3b4b6bbe3efed)> ansible netapp.ontap.na_ontap_nvme – NetApp ONTAP Manage NVMe Service netapp.ontap.na\_ontap\_nvme – NetApp ONTAP Manage NVMe Service =============================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_nvme`. New in version 2.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete NVMe Service Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified NVMe should exist or not. \| \| status\_admin boolean \| Choices:* no * yes \| Whether the status of NVMe should be up or down \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create NVMe na_ontap_nvme: state: present status_admin: False vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Modify NVMe na_ontap_nvme: state: present status_admin: True vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: Delete NVMe na_ontap_nvme: state: absent vserver: "{{ vserver }}" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#5e3039733f302d373c323b2a3b3f33787d6d6965787d6b6c65787d6a6665303b2a3f2e2e787d6a68653d3133)>	programming_docs
ansible netapp.ontap.na_ontap_export_policy_rule – NetApp ONTAP manage export policy rules netapp.ontap.na\_ontap\_export\_policy\_rule – NetApp ONTAP manage export policy rules ====================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_export_policy_rule`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or delete or modify export rules in ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| allow\_suid boolean \| Choices:* no * yes \| If 'true', NFS server will honor SetUID bits in SETATTR operation. Default value on creation is 'true' \| \| anonymous\_user\_id string \| \| User name or ID to which anonymous users are mapped. Default value is '65534'. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| client\_match list / elements=string \| \| List of Client Match host names, IP Addresses, Netgroups, or Domains If rule\_index is not provided, client\_match is used as a key to fetch current rule to determine create,delete,modify actions. If a rule with provided client\_match exists, a new rule will not be created, but the existing rule will be modified or deleted. If a rule with provided client\_match doesn't exist, a new rule will be created if state is present. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the export policy this rule will be added to (or modified, or removed from). aliases: policy\_name \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| protocol list / elements=string \| Choices:* any * nfs * nfs3 * nfs4 * cifs * flexcache \| List of Client access protocols. Default value is set to 'any' during create. \| \| ro\_rule list / elements=string \| Choices:* any * none * never * krb5 * krb5i * krb5p * ntlm * sys \| List of Read only access specifications for the rule \| \| rule\_index integer \| \| index of the export policy rule \| \| rw\_rule list / elements=string \| Choices:* any * none * never * krb5 * krb5i * krb5p * ntlm * sys \| List of Read Write access specifications for the rule \| \| state string \| Choices:* present ← * absent \| Whether the specified export policy rule should exist or not. \| \| super\_user\_security list / elements=string \| Choices:* any * none * never * krb5 * krb5i * krb5p * ntlm * sys \| List of Read Write access specifications for the rule \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create ExportPolicyRule netapp.ontap.na_ontap_export_policy_rule: state: present name: default123 vserver: ci_dev client_match: 0.0.0.0/0,1.1.1.0/24 ro_rule: krb5,krb5i rw_rule: any protocol: nfs,nfs3 super_user_security: any anonymous_user_id: 65534 allow_suid: true hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify ExportPolicyRule netapp.ontap.na_ontap_export_policy_rule: state: present name: default123 rule_index: 100 client_match: 0.0.0.0/0 anonymous_user_id: 65521 ro_rule: ntlm rw_rule: any protocol: any allow_suid: false hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete ExportPolicyRule netapp.ontap.na_ontap_export_policy_rule: state: absent name: default123 rule_index: 100 vserver: ci_dev hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#523c357f333c213b303e372637333f747161656974716760697471666a693c37263322227471666469313d3f)> ansible netapp.ontap.na_ontap_cifs_local_user_modify – NetApp ONTAP modify local CIFS user. netapp.ontap.na\_ontap\_cifs\_local\_user\_modify – NetApp ONTAP modify local CIFS user. ======================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cifs_local_user_modify`. New in version 21.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify a local CIFS user Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| description string \| \| the description for the local cifs user \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| full\_name string \| \| the full name for the local cifs user \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_account\_disabled boolean \| Choices:* no * yes \| Whether the local cifs user is disabled or not \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the local cifs user \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / 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: Enable local CIFS Administrator account na_ontap_cifs_local_user_modify: name: BUILTIN\administrators vserver: ansible is_account_disabled: false username: '{{ username }}' password: '{{ password }}' hostname: '{{ hostname }}' - name: Disable local CIFS Administrator account na_ontap_cifs_local_user_modify: name: BUILTIN\administrators vserver: ansible is_account_disabled: true username: '{{ username }}' password: '{{ password }}' hostname: '{{ hostname }}' ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#7e1019531f100d171c121b0a1b1f13585d4d4945585d4b4c45585d4a4645101b0a1f0e0e585d4a48451d1113)> ansible netapp.ontap.na_ontap_user_role – NetApp ONTAP user role configuration and management netapp.ontap.na\_ontap\_user\_role – NetApp ONTAP user role configuration and management ======================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_user_role`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or destroy user roles Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| access\_level string \| Choices:* none * readonly * all ← \| The name of the role to manage. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| command\_directory\_name string / required \| \| The command or command directory to which the role has an access. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the role to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| query string added in 2.8.0 of netapp.ontap \| \| A query for the role. The query must apply to the specified command or directory name. Use double quotes "" for modifying a existing query to none. \| \| state string \| Choices:* present ← * absent \| Whether the specified user should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create User Role na_ontap_user_role: state: present name: ansibleRole command_directory_name: volume access_level: none query: show vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify User Role na_ontap_user_role: state: present name: ansibleRole command_directory_name: volume access_level: none query: "" vserver: ansibleVServer hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#056b6228646b766c67696071606468232636323e232630373e2326313d3e6b6071647575232631333e666a68)> ansible netapp.ontap.na_ontap_disk_options – NetApp ONTAP modify storage disk options netapp.ontap.na\_ontap\_disk\_options – NetApp ONTAP modify storage disk options ================================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_disk_options`. New in version 21.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify a nodes storage disk options * Requires ONTAP 9.6 or greater Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| autoassign boolean \| Choices:* no * yes \| Whether or not disks should be automatically assigned to a node \| \| autoassign\_policy string \| Choices:* default * bay * shelf * stack \| the auto assign policy to use \| \| autocopy boolean \| Choices:* no * yes \| Whether or not disk auto copies should be enabled \| \| bkg\_firmware\_update boolean \| Choices:* no * yes \| Whether or not background disk firmware updates should be enabled \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| node string / required \| \| The node to modify a disk option for \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Enable Disk Auto Assign na_ontap_disk_options: node: node1 autoassign: true username: '{{ username }}' password: '{{ password }}' hostname: '{{ hostname }}' - name: Disable Disk Auto Assign na_ontap_disk_options: node: node1 autoassign: false username: '{{ username }}' password: '{{ password }}' hostname: '{{ hostname }}' ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c1afa6eca0afb2a8a3ada4b5a4a0ace7e2f2f6fae7e2f4f3fae7e2f5f9faafa4b5a0b1b1e7e2f5f7faa2aeac)>	programming_docs
ansible netapp.ontap.na_ontap_fdss – NetApp ONTAP File Directory Security Set. netapp.ontap.na\_ontap\_fdss – NetApp ONTAP File Directory Security Set. ======================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fdss`. New in version 21.8.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Set file directory security information. * This module is not idempotent. If re-running this module to apply the currently assigned policy, the policy will be reassigned. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies the security policy to apply. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← \| Whether the specified Policy Task should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| Specifies the Vserver that contains the path to which the security policy is applied. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Set File Directory Security netapp.ontap.na_ontap_fdss: state: present vserver: "svm1" name: "ansible_pl" hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#80eee7ade1eef3e9e2ece5f4e5e1eda6a3b3b7bba6a3b5b2bba6a3b4b8bbeee5f4e1f0f0a6a3b4b6bbe3efed)> ansible netapp.ontap.na_ontap_net_port – NetApp ONTAP network ports. netapp.ontap.na\_ontap\_net\_port – NetApp ONTAP network ports. =============================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_net_port`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Modify a ONTAP network port. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| autonegotiate\_admin boolean \| Choices:* no * yes \| Enables or disables Ethernet auto-negotiation of speed, duplex and flow control. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| duplex\_admin string \| \| Specifies the user preferred duplex setting of the port. Valid values auto, half, full \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| flowcontrol\_admin string \| \| Specifies the user preferred flow control setting of the port. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ipspace string \| \| Specifies the port's associated IPspace name. The 'Cluster' ipspace is reserved for cluster ports. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| mtu integer \| \| Specifies the maximum transmission unit (MTU) reported by the port. \| \| node string / required \| \| Specifies the name of node. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| ports list / elements=string / required \| \| Specifies the name of port(s). aliases: port \| \| speed\_admin string \| \| Specifies the user preferred speed setting of the port. \| \| state string \| Choices:* present ← \| Whether the specified net port should exist or not. \| \| up\_admin boolean added in 21.8.0 of netapp.ontap \| Choices:* no * yes \| Enables or disables the port. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Modify Net Port netapp.ontap.na_ontap_net_port: state: present username: "{{ netapp_username }}" password: "{{ netapp_password }}" hostname: "{{ netapp_hostname }}" node: "{{ node_name }}" ports: e0d,e0c autonegotiate_admin: true up_admin: true mtu: 1500 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#2749400a4649544e454b425342464a010414101c010412151c0104131f1c494253465757010413111c44484a)> ansible netapp.ontap.na_ontap_fpolicy_scope – NetApp ONTAP - Create, delete or modify an FPolicy policy scope configuration. netapp.ontap.na\_ontap\_fpolicy\_scope – NetApp ONTAP - Create, delete or modify an FPolicy policy scope configuration. ======================================================================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fpolicy_scope`. New in version 21.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete or modify an FPolicy policy scope. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| check\_extensions\_on\_directories boolean \| Choices:* no * yes \| Indicates whether directory names are also subjected to extensions check, similar to file names. By default, the value is true if policy is configured with Native engine, false otherwise. \| \| export\_policies\_to\_exclude list / elements=string \| \| Export Policies to exclude for file access monitoring. By default no export policy is selected. \| \| export\_policies\_to\_include list / elements=string \| \| Export policies to include for file access monitoring. By default no export policy is selected. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| file\_extensions\_to\_exclude list / elements=string \| \| File extensions excluded for screening. By default no file extension is selected. \| \| file\_extensions\_to\_include list / elements=string \| \| File extensions included for screening. By default no file extension is selected. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_monitoring\_of\_objects\_with\_no\_extension\_enabled boolean \| Choices:* no * yes \| Indicates whether monitoring of objects with no extension is required. By default, the value is false. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Name of the policy. The FPolicy policy must exist for the scope to be created. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| shares\_to\_exclude list / elements=string \| \| Shares to exclude for file access monitoring. By default no share is selected. \| \| shares\_to\_include list / elements=string \| \| Shares to include for file access monitoring. By default no share is selected. \| \| state string \| Choices:* present ← * absent \| Whether the FPolicy policy scope is present or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| \| volumes\_to\_exclude list / elements=string \| \| Volumes that are inactive for the file policy. The list can include items which are regular expressions, such as 'vol\' or 'user?'. Note that if a policy has both an exclude list and an include list, the include list is ignored by the filer when processing user requests. By default no volume is selected. \| \| volumes\_to\_include* list / elements=string \| \| Volumes that are active for the file policy. The list can include items which are regular expressions, such as 'vol\' or 'user?'. By default no volume is selected. \| \| vserver* string / required \| \| the name of the vserver to create the scope on \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create FPolicy scope na_ontap_fpolicy_scope: state: present vserver: GBSMNAS80LD name: policy1 export_policies_to_include: export1 shares_to_include: share1 username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" use_rest: "{{ use_rest }}" - name: Modify FPolicy scope na_ontap_fpolicy_scope: state: present vserver: GBSMNAS80LD name: policy1 export_policies_to_include: export1,export2 shares_to_include: share1,share2 username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" use_rest: "{{ use_rest }}" - name: Delete FPolicy scope na_ontap_fpolicy_scope: state: absent vserver: GBSMNAS80LD name: policy1 username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" use_rest: "{{ use_rest }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f49a93d9959a879d96989180919599d2d7c7c3cfd2d7c1c6cfd2d7c0cccf9a9180958484d2d7c0c2cf979b99)> ansible netapp.ontap.na_ontap_fpolicy_ext_engine – NetApp ONTAP fPolicy external engine configuration. netapp.ontap.na\_ontap\_fpolicy\_ext\_engine – NetApp ONTAP fPolicy external engine configuration. ================================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fpolicy_ext_engine`. New in version 21.4.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete or modify fpolicy external engine. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| certificate\_ca string \| \| Certificate authority name. No default value is set for this field. \| \| certificate\_common\_name string \| \| FQDN or custom common name of certificate. No default value is set for this field. \| \| certificate\_serial string \| \| Serial number of certificate. No default value is set for this field. \| \| extern\_engine\_type string \| Choices:* synchronous * asynchronous \| External engine type. If the engine is asynchronous, no reply is sent from FPolicy servers. Default value set for this field is synchronous. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| is\_resiliency\_enabled boolean \| Choices:* no * yes \| Indicates if the resiliency with this engine is required. If set to true, the notifications will be stored in a path as resiliency\_directory\_path If it is false, the notifications will not be stored. Default value is false. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| max\_connection\_retries integer \| \| Number of times storage appliance will attempt to establish a broken connection to FPolicy server. Default value set for this field is 5. \| \| max\_server\_reqs integer \| \| Maximum number of outstanding screen requests that will be queued for an FPolicy Server. Default value set for this field is 50. \| \| name string / required \| \| Name of the external engine. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| port integer \| \| Port number of the FPolicy server application. \| \| primary\_servers list / elements=string \| \| Primary FPolicy servers. \| \| recv\_buffer\_size integer \| \| Receive buffer size of connected socket for FPolicy Server. Default value set for this field is 256 kilobytes (256Kb). \| \| resiliency\_directory\_path string \| \| Directory path under Vserver for storing file access notifications. File access notifications will be stored in a generated file during the outage time. The path is the full, user visible path relative to the Vserver root, and it might be crossing junction mount points. \| \| secondary\_servers list / elements=string \| \| Secondary FPolicy servers. No default value is set for this field. \| \| send\_buffer\_size integer \| \| Send buffer size of connected socket for FPolicy Server. Default value set for this field is 256 kilobytes (256Kb). \| \| ssl\_option string \| Choices:* no\_auth * server\_auth * mutual\_auth \| SSL option for external communication. No default value is set for this field \| \| state string \| Choices:* present ← * absent \| Whether the fPolicy external engine is present or not \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| the name of the vserver to create the external engine on \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create fPolicy external engine na_ontap_fpolicy_ext_engine: state: present vserver: svm1 name: fpolicy_ext_engine port: 8787 extern_engine_type: asynchronous primary_servers: ['10.11.12.13', '10.11.12.14'] ssl_option: no_auth username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: Modify fPolicy external engine na_ontap_fpolicy_ext_engine: state: present vserver: svm1 name: fpolicy_ext_engine port: 7878 extern_engine_type: synchronous primary_servers: ['10.11.12.15', '10.11.12.16'] ssl_option: server_auth username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" - name: Delete fPolicy external engine na_ontap_fpolicy_ext_engine: state: absent vserver: svm1 name: fpolicy_engine username: "{{ username }}" password: "{{ password }}" hostname: "{{ hostname }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#fe9099d39f908d979c929b8a9b9f93d8ddcdc9c5d8ddcbccc5d8ddcac6c5909b8a9f8e8ed8ddcac8c59d9193)>	programming_docs
ansible netapp.ontap.na_ontap_metrocluster_dr_group – NetApp ONTAP manage MetroCluster DR Group netapp.ontap.na\_ontap\_metrocluster\_dr\_group – NetApp ONTAP manage MetroCluster DR Group =========================================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_metrocluster_dr_group`. New in version 20.11.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete MetroCluster DR Group * Create only supports MCC IP * Delete supports both MCC IP and MCC FC 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.9 * ONTAP >= 9.8 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * REST support requires ONTAP 9.6 or later. * To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| dr\_pairs list / elements=dictionary / required \| \| disaster recovery pairs \| \| \| node\_name string / required \| \| the name of the main node \| \| \| partner\_node\_name string / required \| \| the name of the main partner node \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| partner\_cluster\_name string / required \| \| The name of the partner cluster \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| add or remove DR groups \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Manage MetroCluster DR group hosts: localhost collections: - netapp.ontap vars: login: &login hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" https: True validate_certs: False tasks: - name: Create MetroCluster DR group na_ontap_metrocluster_dr_group: <<: login dr_pairs: - partner_name: carchi_cluster3_01 node_name: carchi_cluster1_01 partner_cluster_name: carchi_cluster3 - name: Delete MetroCluster DR group na_ontap_metrocluster_dr_group: <<: login dr_pairs: - partner_name: carchi_cluster3_01 node_name: carchi_cluster1_01 state: absent partner_cluster_name: carchi_cluster3 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c3ada4eea2adb0aaa1afa6b7a6a2aee5e0f0f4f8e5e0f6f1f8e5e0f7fbf8ada6b7a2b3b3e5e0f7f5f8a0acae)> ansible netapp.ontap.na_ontap_job_schedule – NetApp ONTAP Job Schedule netapp.ontap.na\_ontap\_job\_schedule – NetApp ONTAP Job Schedule ================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_job_schedule`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create/Delete/Modify job-schedules on ONTAP Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| job\_days\_of\_month list / elements=integer added in 2.8.0 of netapp.ontap \| \| The day(s) of the month when the job should be run. Job Manager cron scheduling day of month. -1 represents all days of a month from 1 to 31. Range is [-1..31] \| \| job\_days\_of\_week list / elements=integer added in 2.8.0 of netapp.ontap \| \| The day(s) in the week when the job should be run. Job Manager cron scheduling day of week. Zero represents Sunday. -1 represents all days of a week. Range is [-1..6] \| \| job\_hours list / elements=integer added in 2.8.0 of netapp.ontap \| \| The hour(s) of the day when the job should be run. Job Manager cron scheduling hour. -1 represents all hours. Range is [-1..23] \| \| job\_minutes list / elements=integer \| \| The minute(s) of each hour when the job should be run. Job Manager cron scheduling minute. -1 represents all minutes. Range is [-1..59] Required for create. \| \| job\_months list / elements=integer added in 2.8.0 of netapp.ontap \| \| The month(s) when the job should be run. Job Manager cron scheduling month. -1 represents all months. Range is [-1..12], 0 and 12 may or may not be supported, see `month_offset` \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| month\_offset integer added in 21.9.0 of netapp.ontap \| Choices:* 0 * 1 \| whether January starts at 0 or 1. By default, ZAPI is using a 0..11 range, while REST is using 1..12. default to 0 when using ZAPI, and to 1 when using REST. when set to 0, a value of 12 or higher is rejected. when set to 1, a value of 0 or of 13 or higher is rejected. \| \| name string / required \| \| The name of the job-schedule to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified job schedule should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create Job for 11.30PM at 10th of every month netapp.ontap.na_ontap_job_schedule: state: present name: jobName job_minutes: 30 job_hours: 23 job_days_of_month: 10 job_months: -1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create Job for 11.30PM at 10th of January, April, July, October for ZAPI and REST netapp.ontap.na_ontap_job_schedule: state: present name: jobName job_minutes: 30 job_hours: 23 job_days_of_month: 10 job_months: 1,4,7,10 month_offset: 1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create Job for 11.30PM at 10th of January, April, July, October for ZAPI and REST netapp.ontap.na_ontap_job_schedule: state: present name: jobName job_minutes: 30 job_hours: 23 job_days_of_month: 10 job_months: 0,3,6,9 month_offset: 0 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Create Job for 11.30PM at 10th of January when using REST and February when using ZAPI !!! netapp.ontap.na_ontap_job_schedule: state: present name: jobName job_minutes: 30 job_hours: 23 job_days_of_month: 10 job_months: 1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete Job netapp.ontap.na_ontap_job_schedule: state: absent name: jobName hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#711f165c101f0218131d140514101c575242464a575244434a575245494a1f1405100101575245474a121e1c)> ansible netapp.ontap.na_ontap_fcp – NetApp ONTAP Start, Stop and Enable FCP services. netapp.ontap.na\_ontap\_fcp – NetApp ONTAP Start, Stop and Enable FCP services. =============================================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_fcp`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Start, Stop and Enable FCP services. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the FCP should be enabled or not. \| \| status string \| Choices:* up ← * down \| Whether the FCP should be up or down \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: create FCP na_ontap_fcp: state: present status: down hostname: "{{hostname}}" username: "{{username}}" password: "{{password}}" vserver: "{{vservername}}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#355b5218545b465c57595041505458131606020e131600070e1316010d0e5b5041544545131601030e565a58)> ansible netapp.ontap.na_ontap_ldap_client – NetApp ONTAP LDAP client netapp.ontap.na\_ontap\_ldap\_client – NetApp ONTAP LDAP client =============================================================== Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_ldap_client`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify or delete LDAP client on NetApp ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| ad\_domain string \| \| Active Directory Domain Name. \| \| base\_dn string \| \| LDAP base DN. \| \| base\_scope string \| Choices:* subtree * onelevel * base \| LDAP search scope. \| \| bind\_as\_cifs\_server boolean \| Choices:* no * yes \| The cluster uses the CIFS server's credentials to bind to the LDAP server. \| \| bind\_dn string \| \| LDAP bind user DN. \| \| bind\_password string \| \| LDAP bind user password. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| ldap\_servers list / elements=string \| \| Comma separated list of LDAP servers. FQDN's or IP addreses. Required if state=present. \| \| min\_bind\_level string \| Choices:* anonymous * simple * sasl \| Minimal LDAP server bind level. \| \| name string / required \| \| The name of LDAP client configuration. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| preferred\_ad\_servers list / elements=string \| \| Preferred Active Directory (AD) Domain Controllers. \| \| query\_timeout integer \| \| LDAP server query timeout. \| \| referral\_enabled boolean \| Choices:* no * yes \| LDAP Referral Chasing. \| \| schema string \| \| LDAP schema. Required if state=present. default schemas - 'AD-IDMU', 'AD-SFU', 'MS-AD-BIS', 'RFC-2307'. custom schemas are allowed as well. \| \| session\_security string \| Choices:* none * sign * seal \| Client Session Security. \| \| state string \| Choices:* present ← * absent \| Whether the specified LDAP client configuration exist or not. \| \| tcp\_port integer added in 21.3.0 of netapp.ontap \| \| LDAP server TCP port. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| use\_start\_tls boolean \| Choices:* no * yes \| Start TLS on LDAP connection. \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| vserver/svm that holds LDAP client configuration. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create LDAP client netapp.ontap.na_ontap_ldap_client: state: present name: 'example_ldap' vserver: 'vserver1' ldap_servers: 'ldap1.example.company.com,ldap2.example.company.com' base_dn: 'dc=example,dc=company,dc=com' hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * Milan Zink (@zeten30) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#91ebf4e5f4ffa2a1b7b2a2a6aab7b2a4a3aab7b2a5a9aaf6fcf0f8fdb7b2a5a7aaf2fefc)>/<[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f5988f9c9b9ed3d6c6c2ced3d6c0c7ced3d6c1cdce8790919d9481d3d6c1c3ce969a98)>	programming_docs
ansible netapp.ontap.na_ontap_object_store – NetApp ONTAP manage object store config. netapp.ontap.na\_ontap\_object\_store – NetApp ONTAP manage object store config. ================================================================================ Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_object_store`. New in version 2.9.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or delete object store config on ONTAP. Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| access\_key string \| \| Access key ID for AWS\_S3 and SGWS provider types. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| certificate\_validation\_enabled boolean added in 21.9.0 of netapp.ontap \| Choices:* no * yes \| Is SSL/TLS certificate validation enabled? If not specified, ONTAP will default to true. \| \| container string \| \| Data bucket/container name used in S3 requests. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| The name of the object store config to manage. \| \| ontapi integer \| \| The ontap api version to use \| \| password string \| \| Password for the specified user. aliases: pass \| \| port integer added in 21.9.0 of netapp.ontap \| \| Port number of the object store that ONTAP uses when establishing a connection. \| \| provider\_type string \| \| The name of the object store config provider. \| \| secret\_password string \| \| Secret access key for AWS\_S3 and SGWS provider types. \| \| server string \| \| Fully qualified domain name of the object store config. \| \| ssl\_enabled boolean added in 21.9.0 of netapp.ontap \| Choices:* no * yes \| Is SSL enabled? If not specified, ONTAP will default to true. \| \| state string \| Choices:* present ← * absent \| Whether the specified object store config should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: object store Create netapp.ontap.na_ontap_object_store: state: present name: ansible provider_type: SGWS server: abc container: abc access_key: s3.amazonaws.com secret_password: abc hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" - name: object store Create netapp.ontap.na_ontap_object_store: state: absent name: ansible hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#a6c8c18bc7c8d5cfc4cac3d2c3c7cb808595919d808593949d8085929e9dc8c3d2c7d6d6808592909dc5c9cb)> ansible netapp.ontap.na_ontap_software_update – NetApp ONTAP Update Software netapp.ontap.na\_ontap\_software\_update – NetApp ONTAP Update Software ======================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_software_update`. New in version 2.7.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Update ONTAP software * Requires an https connection and is not supported over http Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| download\_only boolean added in 20.4.0 of netapp.ontap \| Choices:* no ← * yes \| Allows to download image without update. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force\_update boolean added in 20.11.0 of netapp.ontap \| Choices:* no ← * yes \| force an update, even if package\_version matches what is reported as installed. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| ignore\_validation\_warning boolean \| Choices:* no ← * yes \| Allows the update to continue if warnings are encountered during the validation phase. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| nodes list / elements=string \| \| List of nodes to be updated, the nodes have to be a part of a HA Pair. aliases: node \| \| ontapi integer \| \| The ontap api version to use \| \| package\_url string / required \| \| Specifies the package URL to download the package. \| \| package\_version string / required \| \| Specifies the package version to update software. \| \| password string \| \| Password for the specified user. aliases: pass \| \| stabilize\_minutes integer added in 20.6.0 of netapp.ontap \| \| Number of minutes that the update should wait after a takeover or giveback is completed. \| \| state string \| Choices:* present ← \| This module can only download and optionally install the software. \| \| timeout integer \| Default:1800 \| how long to wait for the update to complete, in seconds. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. aliases: user \| \| validate\_after\_download boolean added in 21.11.0 of netapp.ontap \| Choices:* no ← * yes \| By default validation is not run after download, as it is already done in the update step. This option is useful when using `download_only`, for instance when updating a MetroCluster system. \| \| 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. \| Notes ----- Note * ONTAP expects the nodes to be in HA pairs to perform non disruptive updates. * In a single node setup, the node is updated, and rebooted. * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: ONTAP software update netapp.ontap.na_ontap_software_update: state: present nodes: vsim1 package_url: "{{ url }}" package_version: "{{ version_name }}" ignore_validation_warning: True download_only: True hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| validation\_reports string \| always \| `validation_reports_after_update` as a string, for backward compatibility. \| \| validation\_reports\_after\_download list / elements=string \| always \| List of validation reports, after downloading the software package. Note that it is different from the validation checks reported after attempting an update. \| \| validation\_reports\_after\_updates list / elements=string \| always \| List of validation reports, after attemting to update the software package. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#79171e5418170a101b151c0d1c18145f5a4a4e425f5a4c4b425f5a4d4142171c0d1809095f5a4d4f421a1614)> ansible netapp.ontap.na_ontap_cifs_server – NetApp ONTAP CIFS server configuration netapp.ontap.na\_ontap\_cifs\_server – NetApp ONTAP CIFS server configuration ============================================================================= Note This plugin is part of the [netapp.ontap collection](https://galaxy.ansible.com/netapp/ontap) (version 21.12.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.ontap`. To use it in a playbook, specify: `netapp.ontap.na_ontap_cifs_server`. New in version 2.6.0: of netapp.ontap * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Creating / deleting and modifying the CIFS server . Requirements ------------ The below requirements are needed on the host that executes this module. * Ansible 2.9 * Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’ * netapp-lib 2020.3.12 is strongly recommended as it provides better error reporting for connection issues. * A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward. * REST support requires ONTAP 9.6 or later. * 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 \| \| --- \| --- \| --- \| \| admin\_password string \| \| Specifies the cifs server admin password. When used with absent, the account will be deleted if admin\_user\_name is also provided. \| \| admin\_user\_name string \| \| Specifies the cifs server admin username. When used with absent, the account will be deleted if admin\_password is also provided. \| \| cert\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client cert file (.pem). not supported with python 2.6. \| \| domain string \| \| The Fully Qualified Domain Name of the Windows Active Directory this CIFS server belongs to. \| \| feature\_flags dictionary added in 20.5.0 of netapp.ontap \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| force boolean added in 2.7.0 of netapp.ontap \| Choices:* no * yes \| When state is present, if this is set and a machine account with the same name as specified in 'name' exists in the Active Directory, it will be overwritten and reused. When state is absent, if this is set, the local CIFS configuration is deleted regardless of communication errors. \| \| hostname string / required \| \| The hostname or IP address of the ONTAP instance. \| \| http\_port integer \| \| Override the default port (80 or 443) with this port \| \| https boolean \| Choices:* no ← * yes \| Enable and disable https. Ignored when using REST as only https is supported. Ignored when using SSL certificate authentication as it requires SSL. \| \| key\_filepath string added in 20.6.0 of netapp.ontap \| \| path to SSL client key file. \| \| name string / required \| \| Specifies the cifs\_server name. aliases: cifs\_server\_name \| \| ontapi integer \| \| The ontap api version to use \| \| ou string added in 2.7.0 of netapp.ontap \| \| The Organizational Unit (OU) within the Windows Active Directory this CIFS server belongs to. \| \| password string \| \| Password for the specified user. aliases: pass \| \| service\_state string \| Choices:* stopped * started \| CIFS Server Administrative Status. \| \| state string \| Choices:* present ← * absent \| Whether the specified cifs\_server should exist or not. \| \| use\_rest string \| Default:"auto" \| REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. always -- will always use the REST API never -- will always use the ZAPI auto -- will try to use the REST Api \| \| username string \| \| 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/>. Two authentication methods are supported 1. basic authentication, using username and password, 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. 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 string / required \| \| The name of the vserver to use. \| \| workgroup string \| \| The NetBIOS name of the domain or workgroup this CIFS server belongs to. \| Notes ----- Note * The modules prefixed with na\_ontap are built to support the ONTAP storage platform. Examples -------- ``` - name: Create cifs_server netapp.ontap.na_ontap_cifs_server: state: present name: data2 vserver: svm1 service_state: stopped domain: "{{ id_domain }}" admin_user_name: "{{ domain_login }}" admin_password: "{{ domain_pwd }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete cifs_server netapp.ontap.na_ontap_cifs_server: state: absent name: data2 vserver: svm1 admin_user_name: "{{ domain_login }}" admin_password: "{{ domain_pwd }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Start cifs_server netapp.ontap.na_ontap_cifs_server: state: present name: data2 vserver: svm1 service_state: started hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Stop cifs_server netapp.ontap.na_ontap_cifs_server: state: present name: data2 vserver: svm1 service_state: stopped hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Modify cifs_server netapp.ontap.na_ontap_cifs_server: state: present name: data2_new vserver: svm1 admin_user_name: "{{ domain_login }}" admin_password: "{{ domain_pwd }}" hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#94faf3b9f5fae7fdf6f8f1e0f1f5f9b2b7a7a3afb2b7a1a6afb2b7a0acaffaf1e0f5e4e4b2b7a0a2aff7fbf9)>	programming_docs
ansible netapp.um_info.na_um_volumes_info – NetApp Unified Manager list volumes. netapp.um\_info.na\_um\_volumes\_info – NetApp Unified Manager list volumes. ============================================================================ Note This plugin is part of the [netapp.um\_info collection](https://galaxy.ansible.com/netapp/um_info) (version 21.7.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.um_info`. To use it in a playbook, specify: `netapp.um_info.na_um_volumes_info`. New in version 20.6.0: of netapp.um\_info * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * List Volumes on AIQUM. Requirements ------------ The below requirements are needed on the host that executes this module. * A AIQUM 9.7 system. * Ansible 2.9 or later. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| feature\_flags dictionary added in 21.7.0 of netapp.um\_info \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| hostname string / required \| \| The hostname or IP address of the Unified Manager instance. \| \| http\_port integer \| \| Override the default port (443) with this port \| \| max\_records integer added in 21.7.0 of netapp.um\_info \| \| Maximum number of records retrieved in a single GET request. This module loops on GET requests until all available records are fetched. If absent, AIQUM uses 1000. \| \| password string / required \| \| Password for the specified user. \| \| username string / required \| \| username of the Unified Manager instance. \| \| validate\_certs boolean \| Choices:* no * yes ← \| If set to `False`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates. \| Notes ----- Note * With the 21.6.0 release, all modules have been renamed to na\_um\_<module>\_info. The old ones will continue to work but will be depecrated in the future. * The modules prefixed with na\_um are built to support the AIQUM 9.7 platform. * Supports check\_mode. Examples -------- ``` - name: List Volumes netapp.um_info.na_um_volumes_info: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| records list / elements=string \| always \| Returns list of Volumes information Sample: [{'\_links': {'self': {'href': '...'}}, 'aggregates': [{'...': None}], 'autosize': {'...': None}, 'cluster': {'...': None}, 'create\_time': '...', 'key': '...', 'language': '...', 'name': '...', 'qos': {'...': None}, 'snapmirror': {'...': None}, 'snapshot\_policy': {'...': None}, 'space': {'...': None}, 'state': '...', 'style': '...', 'svm': {'...': None, '\_links': {'self': {'...': None}}}, 'tiering': {'...': None}, 'type': '...', 'uuid': '...'}] \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#ddb3baf0bcb3aeb4bfb1b8a9b8bcb0fbfeeeeae6fbfee8efe6fbfee9e5e6b3b8a9bcadadfbfee9ebe6beb2b0)> ansible netapp.um_info.na_um_clusters_info – NetApp Unified Manager list cluster. netapp.um\_info.na\_um\_clusters\_info – NetApp Unified Manager list cluster. ============================================================================= Note This plugin is part of the [netapp.um\_info collection](https://galaxy.ansible.com/netapp/um_info) (version 21.7.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.um_info`. To use it in a playbook, specify: `netapp.um_info.na_um_clusters_info`. New in version 20.5.0: of netapp.um\_info * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * List Cluster on AIQUM. Requirements ------------ The below requirements are needed on the host that executes this module. * A AIQUM 9.7 system. * Ansible 2.9 or later. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| feature\_flags dictionary added in 21.7.0 of netapp.um\_info \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| hostname string / required \| \| The hostname or IP address of the Unified Manager instance. \| \| http\_port integer \| \| Override the default port (443) with this port \| \| max\_records integer added in 21.7.0 of netapp.um\_info \| \| Maximum number of records retrieved in a single GET request. This module loops on GET requests until all available records are fetched. If absent, AIQUM uses 1000. \| \| password string / required \| \| Password for the specified user. \| \| username string / required \| \| username of the Unified Manager instance. \| \| validate\_certs boolean \| Choices:* no * yes ← \| If set to `False`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates. \| Notes ----- Note * With the 21.6.0 release, all modules have been renamed to na\_um\_<module>\_info. The old ones will continue to work but will be depecrated in the future. * The modules prefixed with na\_um are built to support the AIQUM 9.7 platform. * Supports check\_mode. Examples -------- ``` - name: List Clusters netapp.um_info.na_um_clusters_info: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| records list / elements=string \| always \| Returns list of Clusters information Sample: [{'\_links': {'self': {'href': '...'}}, 'contact': '...', 'isSanOptimized': '...', 'key': '', 'location': '...', 'management\_ip': '...', 'name': '...', 'nodes': [{'\_links': {'self': {'href': '...'}}, 'key': '...', 'location': '...', 'model': '...', 'name': '...', 'serial\_number': '...', 'uptime': '...', 'uuid': '...', 'version': {'full': '...', 'generation': '...', 'major': '...', 'minor': '...'}}], 'uuid': '...', 'version': {'full': '...', 'generation': '...', 'major': '...', 'minor': '...'}}] \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#79171e5418170a101b151c0d1c18145f5a4a4e425f5a4c4b425f5a4d4142171c0d1809095f5a4d4f421a1614)> ansible Netapp.Um_Info Netapp.Um\_Info =============== Collection version 21.7.0 Plugin Index ------------ These are the plugins in the netapp.um\_info collection ### Modules * [na\_um\_aggregates\_info](na_um_aggregates_info_module#ansible-collections-netapp-um-info-na-um-aggregates-info-module) – NetApp Unified Manager list aggregates. * [na\_um\_clusters\_info](na_um_clusters_info_module#ansible-collections-netapp-um-info-na-um-clusters-info-module) – NetApp Unified Manager list cluster. * [na\_um\_nodes\_info](na_um_nodes_info_module#ansible-collections-netapp-um-info-na-um-nodes-info-module) – NetApp Unified Manager list nodes. * [na\_um\_svms\_info](na_um_svms_info_module#ansible-collections-netapp-um-info-na-um-svms-info-module) – NetApp Unified Manager list svms. * [na\_um\_volumes\_info](na_um_volumes_info_module#ansible-collections-netapp-um-info-na-um-volumes-info-module) – NetApp Unified Manager list volumes. See also List of [collections](../../index#list-of-collections) with docs hosted here. ansible netapp.um_info.na_um_nodes_info – NetApp Unified Manager list nodes. netapp.um\_info.na\_um\_nodes\_info – NetApp Unified Manager list nodes. ======================================================================== Note This plugin is part of the [netapp.um\_info collection](https://galaxy.ansible.com/netapp/um_info) (version 21.7.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.um_info`. To use it in a playbook, specify: `netapp.um_info.na_um_nodes_info`. New in version 20.5.0: of netapp.um\_info * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * List Nodes on AIQUM. Requirements ------------ The below requirements are needed on the host that executes this module. * A AIQUM 9.7 system. * Ansible 2.9 or later. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| feature\_flags dictionary added in 21.7.0 of netapp.um\_info \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| hostname string / required \| \| The hostname or IP address of the Unified Manager instance. \| \| http\_port integer \| \| Override the default port (443) with this port \| \| max\_records integer added in 21.7.0 of netapp.um\_info \| \| Maximum number of records retrieved in a single GET request. This module loops on GET requests until all available records are fetched. If absent, AIQUM uses 1000. \| \| password string / required \| \| Password for the specified user. \| \| username string / required \| \| username of the Unified Manager instance. \| \| validate\_certs boolean \| Choices:* no * yes ← \| If set to `False`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates. \| Notes ----- Note * With the 21.6.0 release, all modules have been renamed to na\_um\_<module>\_info. The old ones will continue to work but will be depecrated in the future. * The modules prefixed with na\_um are built to support the AIQUM 9.7 platform. * Supports check\_mode. Examples -------- ``` - name: List Nodes netapp.um_info.na_um_nodes_info: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| records list / elements=string \| always \| Returns list of Nodes information Sample: [{'\_links': {'self': {'href': '...'}}, 'allFlashOptimized': '...', 'cluster': {'\_links': {'self': {'href': '...'}}, 'key': '...', 'name': '...', 'uuid': '...'}, 'ha': {'partners': [{'\_links': {}, 'key': '...', 'name': '...', 'uuid': '...'}]}, 'health': '...', 'is\_all\_flash\_optimized': '...', 'key': "...'", 'location': '...', 'model': '...', 'name': '...', 'nvramid': '...', 'serial\_number': '...', 'systemid': '...', 'uptime': '...', 'uuid': '...', 'vendor': '...', 'version': {'full': '...', 'generation': '...', 'major': '...', 'minor': '...'}}] \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#244a4309454a574d46484150414549020717131f020711161f0207101c1f4a4150455454020710121f474b49)> ansible netapp.um_info.na_um_aggregates_info – NetApp Unified Manager list aggregates. netapp.um\_info.na\_um\_aggregates\_info – NetApp Unified Manager list aggregates. ================================================================================== Note This plugin is part of the [netapp.um\_info collection](https://galaxy.ansible.com/netapp/um_info) (version 21.7.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.um_info`. To use it in a playbook, specify: `netapp.um_info.na_um_aggregates_info`. New in version 20.5.0: of netapp.um\_info * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * List Aggregates on AIQUM. Requirements ------------ The below requirements are needed on the host that executes this module. * A AIQUM 9.7 system. * Ansible 2.9 or later. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| feature\_flags dictionary added in 21.7.0 of netapp.um\_info \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| hostname string / required \| \| The hostname or IP address of the Unified Manager instance. \| \| http\_port integer \| \| Override the default port (443) with this port \| \| max\_records integer added in 21.7.0 of netapp.um\_info \| \| Maximum number of records retrieved in a single GET request. This module loops on GET requests until all available records are fetched. If absent, AIQUM uses 1000. \| \| password string / required \| \| Password for the specified user. \| \| username string / required \| \| username of the Unified Manager instance. \| \| validate\_certs boolean \| Choices:* no * yes ← \| If set to `False`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates. \| Notes ----- Note * With the 21.6.0 release, all modules have been renamed to na\_um\_<module>\_info. The old ones will continue to work but will be depecrated in the future. * The modules prefixed with na\_um are built to support the AIQUM 9.7 platform. * Supports check\_mode. Examples -------- ``` - name: List Aggregates netapp.um_info.na_um_aggregates_info: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| records list / elements=string \| always \| Returns list of Aggregates information Sample: [{'\_links': {'self': {'href': '...'}}, 'block\_storage': {'hybrid\_cache': {'enabled': '...', 'size': '...'}, 'mirror': {'state': '...'}, 'primary': {'raid\_size': '...', 'raid\_type': '...'}}, 'cluster': {'\_links': {'self': {'href': '...'}}, 'key': '...', 'name': '...', 'uuid': '...'}, 'create\_time': '...', 'data\_encryption': {'software\_encryption\_enabled': '...'}, 'key': '...', 'name': '...', 'node': {'\_links': {'self': {'href': '...'}}, 'key': '...', 'name': '...', 'uuid': '...'}, 'snaplock\_type': '...', 'space': {'block\_storage': {'available': '...', 'size': '...', 'used': '...'}, 'efficiency': {'logical\_used': '...', 'savings': '...'}}, 'state': '...', 'type': '...', 'uuid': '...'}] \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1678713b7778657f747a736273777b303525212d303523242d3035222e2d787362776666303522202d75797b)> ansible netapp.um_info.na_um_svms_info – NetApp Unified Manager list svms. netapp.um\_info.na\_um\_svms\_info – NetApp Unified Manager list svms. ====================================================================== Note This plugin is part of the [netapp.um\_info collection](https://galaxy.ansible.com/netapp/um_info) (version 21.7.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.um_info`. To use it in a playbook, specify: `netapp.um_info.na_um_svms_info`. New in version 20.5.0: of netapp.um\_info * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * List SVMs on AIQUM. Requirements ------------ The below requirements are needed on the host that executes this module. * A AIQUM 9.7 system. * Ansible 2.9 or later. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| feature\_flags dictionary added in 21.7.0 of netapp.um\_info \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| hostname string / required \| \| The hostname or IP address of the Unified Manager instance. \| \| http\_port integer \| \| Override the default port (443) with this port \| \| max\_records integer added in 21.7.0 of netapp.um\_info \| \| Maximum number of records retrieved in a single GET request. This module loops on GET requests until all available records are fetched. If absent, AIQUM uses 1000. \| \| password string / required \| \| Password for the specified user. \| \| username string / required \| \| username of the Unified Manager instance. \| \| validate\_certs boolean \| Choices:* no * yes ← \| If set to `False`, the SSL certificates will not be validated. This should only set to `False` used on personally controlled sites using self-signed certificates. \| Notes ----- Note * With the 21.6.0 release, all modules have been renamed to na\_um\_<module>\_info. The old ones will continue to work but will be depecrated in the future. * The modules prefixed with na\_um are built to support the AIQUM 9.7 platform. * Supports check\_mode. Examples -------- ``` - name: List SVMs netapp.um_info.na_um_svms_info: hostname: "{{ hostname }}" username: "{{ username }}" password: "{{ password }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| records list / elements=string \| always \| Returns list of SVMs information Sample: [{'\_links': {'self': {'href': '...'}}, 'aggregates': [{'\_links': {'self': {'href': '...'}}, 'key': '...', 'name': '...', 'uuid': '...'}], 'cifs': {'ad\_domain': {'fqdn': '...'}, 'enabled': '...', 'name': '...'}, 'cluster': {'\_links': {'self': {'href': '...'}}, 'key': '...', 'name': '...', 'uuid': '...'}, 'dns': '...', 'fcp': {'enabled': '...'}, 'ipspace': {'\_links': {}, 'key': '...', 'name': '...', 'uuid': '...'}, 'iscsi': {'enabled': '...'}, 'key': '...', 'language': '...', 'ldap': {'enabled': '...'}, 'name': '...', 'nfs': {'enabled': '...'}, 'nis': {'domain': '...', 'enabled': '...', 'servers': '...'}, 'nvme': {'enabled': '...'}, 'snapshot\_policy': {'\_links': {}, 'key': '...', 'name': '...', 'uuid': '...'}, 'state': '...', 'subtype': 'default', 'uuid': '...'}] \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#bcd2db91ddd2cfd5ded0d9c8d9ddd19a9f8f8b879a9f898e879a9f888487d2d9c8ddcccc9a9f888a87dfd3d1)>	programming_docs
ansible netapp.elementsw.na_elementsw_cluster_config – Configure Element SW Cluster netapp.elementsw.na\_elementsw\_cluster\_config – Configure Element SW Cluster ============================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_cluster_config`. New in version 2.8.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Configure Element Software cluster. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| enable\_virtual\_volumes boolean \| Choices:* no * yes ← \| Enable the NetApp SolidFire VVols cluster feature \| \| encryption\_at\_rest string \| Choices:* present * absent \| enable or disable the Advanced Encryption Standard (AES) 256-bit encryption at rest on the cluster \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| modify\_cluster\_full\_threshold dictionary \| \| The capacity level at which the cluster generates an event Requires a stage3\_block\_threshold\_percent or max\_metadata\_over\_provision\_factor or stage2\_aware\_threshold \| \| \| max\_metadata\_over\_provision\_factor integer \| \| The number of times metadata space can be overprovisioned relative to the amount of space available \| \| \| stage2\_aware\_threshold integer \| \| The number of nodes of capacity remaining in the cluster before the system triggers a notification \| \| \| stage3\_block\_threshold\_percent integer \| \| The percentage below the "Error" threshold that triggers a cluster "Warning" alert \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| set\_ntp\_info dictionary \| \| configure NTP on cluster node Requires a list of one or more ntp\_servers \| \| \| broadcastclient boolean \| Choices:* no ← * yes \| Enables every node in the cluster as a broadcast client \| \| \| ntp\_servers list / elements=string \| \| list of NTP servers to add to each nodes NTP configuration \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Configure cluster tags: - elementsw_cluster_config na_elementsw_cluster_config: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" modify_cluster_full_threshold: stage2_aware_threshold: 2 stage3_block_threshold_percent: 10 max_metadata_over_provision_factor: 2 encryption_at_rest: absent set_ntp_info: broadcastclient: False ntp_servers: - 1.1.1.1 - 2.2.2.2 enable_virtual_volumes: True ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#8de3eaa0ece3fee4efe1e8f9e8ece0abaebebab6abaeb8bfb6abaeb9b5b6e3e8f9ecfdfdabaeb9bbb6eee2e0)> ansible netapp.elementsw.na_elementsw_volume_pair – NetApp Element Software Volume Pair netapp.elementsw.na\_elementsw\_volume\_pair – NetApp Element Software Volume Pair ================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_volume_pair`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete volume pair Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| dest\_account string / required \| \| Destination account name or ID \| \| dest\_mvip string / required \| \| Destination IP address of the paired cluster. \| \| dest\_password string \| \| Destination password for the paired cluster Optional if this is same as source cluster password. \| \| dest\_username string \| \| Destination username for the paired cluster Optional if this is same as source cluster username. \| \| dest\_volume string / required \| \| Destination volume name or volume ID \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| mode string \| Choices:* async ← * sync * snapshotsonly \| Mode to start the volume pairing \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| src\_account string / required \| \| Source account name or ID \| \| src\_volume string / required \| \| Source volume name or volume ID \| \| state string \| Choices:* present ← * absent \| Whether the specified volume pair should exist or not. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Create volume pair na_elementsw_volume_pair: hostname: "{{ src_cluster_hostname }}" username: "{{ src_cluster_username }}" password: "{{ src_cluster_password }}" state: present src_volume: test1 src_account: test2 dest_volume: test3 dest_account: test4 mode: sync dest_mvip: "{{ dest_cluster_hostname }}" - name: Delete volume pair na_elementsw_volume_pair: hostname: "{{ src_cluster_hostname }}" username: "{{ src_cluster_username }}" password: "{{ src_cluster_password }}" state: absent src_volume: 3 src_account: 1 dest_volume: 2 dest_account: 1 dest_mvip: "{{ dest_cluster_hostname }}" dest_username: "{{ dest_cluster_username }}" dest_password: "{{ dest_cluster_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#a2ccc58fc3ccd1cbc0cec7d6c7c3cf848191959984819790998481969a99ccc7d6c3d2d28481969499c1cdcf)> ansible netapp.elementsw.na_elementsw_drive – NetApp Element Software Manage Node Drives netapp.elementsw.na\_elementsw\_drive – NetApp Element Software Manage Node Drives ================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_drive`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add, Erase or Remove drive for nodes on Element Software Cluster. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| drive\_ids list / elements=string \| \| List of Drive IDs or Serial Names of Node drives. If not specified, add and remove action will be performed on all drives of node\_id aliases: drive\_id \| \| force\_during\_bin\_sync boolean \| Choices:* no * yes \| Flag to force during a bin sync operation. Not supported with latest version of SolidFire SDK (1.7.0.152) \| \| force\_during\_upgrade boolean \| Choices:* no * yes \| Flag to force drive operation during upgrade. Not supported with latest version of SolidFire SDK (1.7.0.152) \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| node\_ids list / elements=string \| \| List of IDs or Names of cluster nodes. If node\_ids and drive\_ids are not specified, all available drives in the cluster are added if state is present. If node\_ids and drive\_ids are not specified, all active drives in the cluster are removed if state is absent. aliases: node\_id \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent * clean \| Element SW Storage Drive operation state. present - To add drive of node to participate in cluster data storage. absent - To remove the drive from being part of active cluster. clean - Clean-up any residual data persistent on a \removed\ drive in a secured method. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Add drive with status available to cluster tags: - elementsw_add_drive na_elementsw_drive: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present drive_ids: scsi-SATA_SAMSUNG_MZ7LM48S2UJNX0J3221807 force_during_upgrade: false force_during_bin_sync: false node_ids: sf4805-meg-03 - name: Remove active drive from cluster tags: - elementsw_remove_drive na_elementsw_drive: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent force_during_upgrade: false drive_ids: scsi-SATA_SAMSUNG_MZ7LM48S2UJNX0J321208 - name: Secure Erase drive tags: - elemensw_clean_drive na_elementsw_drive: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: clean drive_ids: scsi-SATA_SAMSUNG_MZ7LM48S2UJNX0J432109 node_ids: sf4805-meg-03 - name: Add all the drives of all nodes to cluster tags: - elementsw_add_node na_elementsw_drive: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present force_during_upgrade: false force_during_bin_sync: false ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c4aaa3e9a5aab7ada6a8a1b0a1a5a9e2e7f7f3ffe2e7f1f6ffe2e7f0fcffaaa1b0a5b4b4e2e7f0f2ffa7aba9)> ansible netapp.elementsw.na_elementsw_admin_users – NetApp Element Software Manage Admin Users netapp.elementsw.na\_elementsw\_admin\_users – NetApp Element Software Manage Admin Users ========================================================================================= Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_admin_users`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, destroy, or update admin users on SolidFire Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| acceptEula boolean \| Choices:* no * yes \| Boolean, true for accepting Eula, False Eula \| \| access list / elements=string \| \| A list of types the admin has access to \| \| element\_password string \| \| The password for the new admin account. Setting the password attribute will always reset your password, even if the password is the same \| \| element\_username string / required \| \| Unique username for this account. (May be 1 to 64 characters in length). \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified account should exist or not. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Add admin user na_elementsw_admin_users: state: present username: "{{ admin_user_name }}" password: "{{ admin_password }}" hostname: "{{ hostname }}" element_username: carchi8py element_password: carchi8py acceptEula: True access: accounts,drives - name: modify admin user na_elementsw_admin_users: state: present username: "{{ admin_user_name }}" password: "{{ admin_password }}" hostname: "{{ hostname }}" element_username: carchi8py element_password: carchi8py12 acceptEula: True access: accounts,drives,nodes - name: delete admin user na_elementsw_admin_users: state: absent username: "{{ admin_user_name }}" password: "{{ admin_password }}" hostname: "{{ hostname }}" element_username: carchi8py ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#7a141d571b14091318161f0e1f1b175c59494d415c594f48415c594e4241141f0e1b0a0a5c594e4c41191517)> ansible Netapp.Elementsw Netapp.Elementsw ================ Collection version 21.6.1 Plugin Index ------------ These are the plugins in the netapp.elementsw collection ### Modules * [na\_elementsw\_access\_group](na_elementsw_access_group_module#ansible-collections-netapp-elementsw-na-elementsw-access-group-module) – NetApp Element Software Manage Access Groups * [na\_elementsw\_access\_group\_volumes](na_elementsw_access_group_volumes_module#ansible-collections-netapp-elementsw-na-elementsw-access-group-volumes-module) – NetApp Element Software Add/Remove Volumes to/from Access Group * [na\_elementsw\_account](na_elementsw_account_module#ansible-collections-netapp-elementsw-na-elementsw-account-module) – NetApp Element Software Manage Accounts * [na\_elementsw\_admin\_users](na_elementsw_admin_users_module#ansible-collections-netapp-elementsw-na-elementsw-admin-users-module) – NetApp Element Software Manage Admin Users * [na\_elementsw\_backup](na_elementsw_backup_module#ansible-collections-netapp-elementsw-na-elementsw-backup-module) – NetApp Element Software Create Backups * [na\_elementsw\_check\_connections](na_elementsw_check_connections_module#ansible-collections-netapp-elementsw-na-elementsw-check-connections-module) – NetApp Element Software Check connectivity to MVIP and SVIP. * [na\_elementsw\_cluster](na_elementsw_cluster_module#ansible-collections-netapp-elementsw-na-elementsw-cluster-module) – NetApp Element Software Create Cluster * [na\_elementsw\_cluster\_config](na_elementsw_cluster_config_module#ansible-collections-netapp-elementsw-na-elementsw-cluster-config-module) – Configure Element SW Cluster * [na\_elementsw\_cluster\_pair](na_elementsw_cluster_pair_module#ansible-collections-netapp-elementsw-na-elementsw-cluster-pair-module) – NetApp Element Software Manage Cluster Pair * [na\_elementsw\_cluster\_snmp](na_elementsw_cluster_snmp_module#ansible-collections-netapp-elementsw-na-elementsw-cluster-snmp-module) – Configure Element SW Cluster SNMP * [na\_elementsw\_drive](na_elementsw_drive_module#ansible-collections-netapp-elementsw-na-elementsw-drive-module) – NetApp Element Software Manage Node Drives * [na\_elementsw\_info](na_elementsw_info_module#ansible-collections-netapp-elementsw-na-elementsw-info-module) – NetApp Element Software Info * [na\_elementsw\_initiators](na_elementsw_initiators_module#ansible-collections-netapp-elementsw-na-elementsw-initiators-module) – Manage Element SW initiators * [na\_elementsw\_ldap](na_elementsw_ldap_module#ansible-collections-netapp-elementsw-na-elementsw-ldap-module) – NetApp Element Software Manage ldap admin users * [na\_elementsw\_network\_interfaces](na_elementsw_network_interfaces_module#ansible-collections-netapp-elementsw-na-elementsw-network-interfaces-module) – NetApp Element Software Configure Node Network Interfaces * [na\_elementsw\_node](na_elementsw_node_module#ansible-collections-netapp-elementsw-na-elementsw-node-module) – NetApp Element Software Node Operation * [na\_elementsw\_qos\_policy](na_elementsw_qos_policy_module#ansible-collections-netapp-elementsw-na-elementsw-qos-policy-module) – NetApp Element Software create/modify/rename/delete QOS Policy * [na\_elementsw\_snapshot](na_elementsw_snapshot_module#ansible-collections-netapp-elementsw-na-elementsw-snapshot-module) – NetApp Element Software Manage Snapshots * [na\_elementsw\_snapshot\_restore](na_elementsw_snapshot_restore_module#ansible-collections-netapp-elementsw-na-elementsw-snapshot-restore-module) – NetApp Element Software Restore Snapshot * [na\_elementsw\_snapshot\_schedule](na_elementsw_snapshot_schedule_module#ansible-collections-netapp-elementsw-na-elementsw-snapshot-schedule-module) – NetApp Element Software Snapshot Schedules * [na\_elementsw\_vlan](na_elementsw_vlan_module#ansible-collections-netapp-elementsw-na-elementsw-vlan-module) – NetApp Element Software Manage VLAN * [na\_elementsw\_volume](na_elementsw_volume_module#ansible-collections-netapp-elementsw-na-elementsw-volume-module) – NetApp Element Software Manage Volumes * [na\_elementsw\_volume\_clone](na_elementsw_volume_clone_module#ansible-collections-netapp-elementsw-na-elementsw-volume-clone-module) – NetApp Element Software Create Volume Clone * [na\_elementsw\_volume\_pair](na_elementsw_volume_pair_module#ansible-collections-netapp-elementsw-na-elementsw-volume-pair-module) – NetApp Element Software Volume Pair See also List of [collections](../../index#list-of-collections) with docs hosted here.	programming_docs
ansible netapp.elementsw.na_elementsw_cluster_pair – NetApp Element Software Manage Cluster Pair netapp.elementsw.na\_elementsw\_cluster\_pair – NetApp Element Software Manage Cluster Pair =========================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_cluster_pair`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete cluster pair Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| dest\_mvip string / required \| \| Destination IP address of the cluster to be paired. \| \| dest\_password string \| \| Destination password for the cluster to be paired. Optional if this is same as source cluster password. \| \| dest\_username string \| \| Destination username for the cluster to be paired. Optional if this is same as source cluster username. \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified cluster pair should exist or not. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Create cluster pair na_elementsw_cluster_pair: hostname: "{{ src_hostname }}" username: "{{ src_username }}" password: "{{ src_password }}" state: present dest_mvip: "{{ dest_hostname }}" - name: Delete cluster pair na_elementsw_cluster_pair: hostname: "{{ src_hostname }}" username: "{{ src_username }}" password: "{{ src_password }}" state: absent dest_mvip: "{{ dest_hostname }}" dest_username: "{{ dest_username }}" dest_password: "{{ dest_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#7b151c561a15081219171e0f1e1a165d58484c405d584e49405d584f4340151e0f1a0b0b5d584f4d40181416)> ansible netapp.elementsw.na_elementsw_ldap – NetApp Element Software Manage ldap admin users netapp.elementsw.na\_elementsw\_ldap – NetApp Element Software Manage ldap admin users ====================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_ldap`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Enable, disable ldap, and add ldap users Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| authType string \| Choices:* DirectBind * SearchAndBind \| Identifies which user authentication method to use. \| \| groupSearchBaseDn string \| \| The base DN of the tree to start the group search (will do a subtree search from here) \| \| groupSearchCustomFilter string \| \| For use with the CustomFilter Search type \| \| groupSearchType string \| Choices:* NoGroup * ActiveDirectory * MemberDN \| Controls the default group search filter used \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| searchBindDN string \| \| A dully qualified DN to log in with to perform an LDAp search for the user (needs read access to the LDAP directory). \| \| searchBindPassword string \| \| The password for the searchBindDN account used for searching \| \| serverURIs string \| \| A comma-separated list of LDAP server URIs \| \| state string \| Choices:* present ← * absent \| Whether the specified volume should exist or not. \| \| userDNTemplate string \| \| A string that is used form a fully qualified user DN. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| \| userSearchBaseDN string \| \| The base DN of the tree to start the search (will do a subtree search from here) \| \| userSearchFilter string \| \| the LDAP Filter to use \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: disable ldap authentication na_elementsw_ldap: state: absent username: "{{ admin username }}" password: "{{ admin password }}" hostname: "{{ hostname }}" - name: Enable ldap authentication na_elementsw_ldap: state: present username: "{{ admin username }}" password: "{{ admin password }}" hostname: "{{ hostname }}" authType: DirectBind serverURIs: ldap://svmdurlabesx01spd_ldapclnt groupSearchType: MemberDN userDNTemplate: uid=%USERNAME%,cn=users,cn=accounts,dc=corp,dc="{{ company name }}",dc=com ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#94faf3b9f5fae7fdf6f8f1e0f1f5f9b2b7a7a3afb2b7a1a6afb2b7a0acaffaf1e0f5e4e4b2b7a0a2aff7fbf9)> ansible netapp.elementsw.na_elementsw_info – NetApp Element Software Info netapp.elementsw.na\_elementsw\_info – NetApp Element Software Info =================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_info`. New in version 20.10.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Collect cluster and node information. * Use a MVIP as hostname for cluster and node scope. * Use a MIP as hostname for node scope. * When using MIPs, cluster APIs are expected to fail with ‘xUnknownAPIMethod method=ListAccounts’ Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| fail\_on\_error boolean \| Choices:* no ← * yes \| by default, errors are not fatal when collecting a subset. The subset will show on error in the info output. if set to True, the module fails on the first error. \| \| fail\_on\_key\_not\_found boolean \| Choices:* no * yes ← \| force an error when filter is used and a key is not present in records. \| \| fail\_on\_record\_not\_found boolean \| Choices:* no ← * yes \| force an error when filter is used and no record is matched. \| \| filter dictionary \| \| When a list of records is returned, this can be used to limit the records to be returned. If more than one key is used, all keys must match. \| \| gather\_subsets list / elements=string \| Default:["all"] \| list of subsets to gather from target cluster or node supported values node\_config, cluster\_accounts, cluster\_nodes, cluster\_drives. additional values all - for all subsets, all\_clusters - all subsets at cluster scope, all\_nodes - all subsets at node scope aliases: gather\_subset \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: get all available subsets na_elementsw_info: hostname: "{{ elementsw_mvip }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" gather_subsets: all register: result - name: collect data for elementsw accounts using a filter na_elementsw_info: hostname: "{{ elementsw_mvip }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" gather_subsets: 'cluster_accounts' filter: username: "{{ username_to_find }}" register: result ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| debug list / elements=string \| success \| a list of detailed error messages if some subsets cannot be collected \| \| info dictionary \| success \| a dictionary of collected subsets each subset if in JSON format \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#355b5218545b465c57595041505458131606020e131600070e1316010d0e5b5041544545131601030e565a58)> ansible netapp.elementsw.na_elementsw_node – NetApp Element Software Node Operation netapp.elementsw.na\_elementsw\_node – NetApp Element Software Node Operation ============================================================================= Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_node`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add, remove cluster node on Element Software Cluster. * Set cluster name on node. * When using the preset\_only option, hostname/username/password are required but not used. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| cluster\_name string added in 20.9.0 of netapp.elementsw \| \| If set, the current node configuration is updated with this name before adding the node to the cluster. This requires the node\_ids to be specified as MIPs (Management IP Adresses) \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| node\_ids list / elements=string / required \| \| List of IDs or Names or IP Addresses of nodes to add or remove. If cluster\_name is set, node MIPs are required. aliases: node\_id \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| preset\_only boolean added in 20.9.0 of netapp.elementsw \| Choices:* no ← * yes \| If true and state is 'present', set the cluster name for each node in node\_ids, but do not add the nodes. They can be added using na\_elementsw\_cluster for initial cluster creation. If false, proceed with addition/removal. \| \| state string \| Choices:* present ← * absent \| Element Software Storage Node operation state. present - To add pending node to participate in cluster data storage. absent - To remove node from active cluster. A node cannot be removed if active drives are present. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Add node from pending to active cluster tags: - elementsw_add_node na_elementsw_node: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present node_id: sf4805-meg-03 - name: Remove active node from cluster tags: - elementsw_remove_node na_elementsw_node: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent node_id: 13 - name: Add node from pending to active cluster using node IP tags: - elementsw_add_node_ip na_elementsw_node: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present node_id: 10.109.48.65 cluster_name: sfcluster01 - name: Only set cluster name tags: - elementsw_add_node_ip na_elementsw_node: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present node_ids: 10.109.48.65,10.109.48.66 cluster_name: sfcluster01 preset_only: true ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#0668612b6768756f646a637263676b202535313d202533343d2025323e3d686372677676202532303d65696b)> ansible netapp.elementsw.na_elementsw_qos_policy – NetApp Element Software create/modify/rename/delete QOS Policy netapp.elementsw.na\_elementsw\_qos\_policy – NetApp Element Software create/modify/rename/delete QOS Policy ============================================================================================================ Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_qos_policy`. New in version 20.9.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, modify, rename, or delete QOS policy on Element Software Cluster. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| debug boolean added in 21.3.0 of netapp.elementsw \| Choices:* no ← * yes \| report additional information when set to true. \| \| from\_name string \| \| Name or id for the QOS policy to be renamed. \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| name string / required \| \| Name or id for the QOS policy. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| qos dictionary \| \| The quality of service (QQOS) for the policy. Required for create Supported keys are minIOPS, maxIOPS, burstIOPS \| \| \| burstIOPS integer added in 21.3.0 of netapp.elementsw \| \| The maximum number of IOPS allowed over a short period of time for the volume. \| \| \| maxIOPS integer added in 21.3.0 of netapp.elementsw \| \| The maximum number of IOPS allowed for the volume. \| \| \| minIOPS integer added in 21.3.0 of netapp.elementsw \| \| The minimum number of IOPS guaranteed for the volume. \| \| state string \| Choices:* present ← * absent \| Whether the specified QOS policy should exist or not. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Add QOS Policy na_elementsw_qos_policy: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present name: gold qos: {minIOPS: 1000, maxIOPS: 20000, burstIOPS: 50000} - name: Modify QOS Policy na_elementsw_qos_policy: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent name: gold qos: {minIOPS: 100, maxIOPS: 5000, burstIOPS: 20000} - name: Rename QOS Policy na_elementsw_qos_policy: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent from_name: gold name: silver - name: Remove QOS Policy na_elementsw_qos_policy: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent name: silver ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#3658511b5758455f545a534253575b101505010d101503040d1015020e0d585342574646101502000d55595b)>	programming_docs
ansible netapp.elementsw.na_elementsw_backup – NetApp Element Software Create Backups netapp.elementsw.na\_elementsw\_backup – NetApp Element Software Create Backups =============================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_backup`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create backup Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| dest\_hostname string \| \| hostname for the backup source cluster will be set equal to hostname if not specified \| \| dest\_password string \| \| password for the backup destination cluster will be set equal to password if not specified \| \| dest\_username string \| \| username for the backup destination cluster will be set equal to username if not specified \| \| dest\_volume\_id string / required \| \| ID of the backup destination volume \| \| format string \| Choices:* native ← * uncompressed \| Backup format to use \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| script string \| \| the backup script to be executed \| \| script\_parameters dictionary \| \| the backup script parameters \| \| src\_volume\_id string / required \| \| ID of the backup source volume. aliases: volume\_id \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` na_elementsw_backup: hostname: "{{ source_cluster_hostname }}" username: "{{ source_cluster_username }}" password: "{{ source_cluster_password }}" src_volume_id: 1 dest_hostname: "{{ destination_cluster_hostname }}" dest_username: "{{ destination_cluster_username }}" dest_password: "{{ destination_cluster_password }}" dest_volume_id: 3 format: native ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#ef8188c28e819c868d838a9b8a8e82c9ccdcd8d4c9ccdaddd4c9ccdbd7d4818a9b8e9f9fc9ccdbd9d48c8082)> ansible netapp.elementsw.na_elementsw_cluster – NetApp Element Software Create Cluster netapp.elementsw.na\_elementsw\_cluster – NetApp Element Software Create Cluster ================================================================================ Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_cluster`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Initialize Element Software node ownership to form a cluster. * If the cluster does not exist, username/password are still required but ignored for initial creation. * username/password are used as the node credentials to see if the cluster already exists. * username/password can also be used to set the cluster credentials. * If the cluster already exists, no error is returned, but changed is set to false. * Cluster modifications are not supported and are ignored. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| accept\_eula boolean \| Choices:* no * yes \| Required to indicate your acceptance of the End User License Agreement when creating this cluster. To accept the EULA, set this parameter to true. \| \| attributes dictionary \| \| List of name-value pairs in JSON object format. \| \| cluster\_admin\_password string \| \| Initial password for the cluster admin account. If not provided, default to password. \| \| cluster\_admin\_username string \| \| Username for the cluster admin. If not provided, default to username. \| \| encryption boolean added in 20.10.0 of netapp.elementsw \| Choices:* no * yes \| to enable or disable encryption at rest \| \| fail\_if\_cluster\_already\_exists\_with\_larger\_ensemble boolean added in 20.8.0 of netapp.elementsw \| Choices:* no * yes ← \| If the cluster exists, the default is to verify that nodes is a superset of the existing ensemble. A superset is accepted because some nodes may have a different role. But the module reports an error if the existing ensemble contains a node not listed in nodes. This checker is disabled when this option is set to false. \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| management\_virtual\_ip string / required \| \| Floating (virtual) IP address for the cluster on the management network. \| \| nodes list / elements=string / required \| \| Storage IP (SIP) addresses of the initial set of nodes making up the cluster. nodes IP must be in the list. \| \| order\_number string added in 20.10.0 of netapp.elementsw \| \| (experimental) order number as provided by NetApp \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| replica\_count integer \| Default:2 \| Number of replicas of each piece of data to store in the cluster. \| \| serial\_number string added in 20.10.0 of netapp.elementsw \| \| (experimental) serial number as provided by NetApp \| \| storage\_virtual\_ip string / required \| \| Floating (virtual) IP address for the cluster on the storage (iSCSI) network. \| \| timeout integer added in 20.8.0 of netapp.elementsw \| Default:100 \| Time to wait for cluster creation to complete. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Initialize new cluster tags: - elementsw_cluster na_elementsw_cluster: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" management_virtual_ip: 10.226.108.32 storage_virtual_ip: 10.226.109.68 replica_count: 2 accept_eula: true nodes: - 10.226.109.72 - 10.226.109.74 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b1dfd69cd0dfc2d8d3ddd4c5d4d0dc979282868a979284838a979285898adfd4c5d0c1c1979285878ad2dedc)> ansible netapp.elementsw.na_elementsw_access_group_volumes – NetApp Element Software Add/Remove Volumes to/from Access Group netapp.elementsw.na\_elementsw\_access\_group\_volumes – NetApp Element Software Add/Remove Volumes to/from Access Group ======================================================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_access_group_volumes`. New in version 20.1.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Add or remove volumes to/from access group on Element Software Cluster. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| access\_group string / required \| \| Name or id for the access group to add volumes to, or remove volumes from \| \| account\_id string / required \| \| Account ID for the owner of this volume. It accepts either account\_name or account\_id if account\_id is numeric, look up for account\_id first, then look up for account\_name If account\_id is not numeric, look up for account\_name \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified volumes should exist or not for this access group. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| \| volumes list / elements=string / required \| \| List of volumes to add/remove from/to the access group. It accepts either volume\_name or volume\_id \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Add Volumes to Access Group na_elementsw_access_group: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present access_group: AnsibleAccessGroup volumes: ['vol7','vol8','vol9'] account_id: '1' - name: Remove Volumes from Access Group na_elementsw_access_group: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent access_group: AnsibleAccessGroup volumes: ['vol7','vol9'] account_id: '1' ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1779703a7679647e757b726372767a313424202c313422252c3134232f2c797263766767313423212c74787a)> ansible netapp.elementsw.na_elementsw_access_group – NetApp Element Software Manage Access Groups netapp.elementsw.na\_elementsw\_access\_group – NetApp Element Software Manage Access Groups ============================================================================================ Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_access_group`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, destroy, or update access groups on Element Software Cluster. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_id string added in 2.8.0 of netapp.elementsw \| \| Account ID for the owner of this volume. It accepts either account\_name or account\_id if account\_id is digit, it will consider as account\_id If account\_id is string, it will consider as account\_name \| \| attributes dictionary \| \| List of Name/Value pairs in JSON object format. \| \| from\_name string added in 2.8.0 of netapp.elementsw \| \| ID or Name of the access group to rename. Required to create a new access group called 'name' by renaming 'from\_name'. \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| initiators list / elements=string \| \| List of initiators to include in the access group. If unspecified, the access group will start out without configured initiators. \| \| name string / required \| \| Name for the access group for create, modify and delete operations. aliases: src\_access\_group\_id \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified access group should exist or not. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| \| virtual\_network\_id integer \| \| The ID of the Element SW Software Cluster Virtual Network to associate the access group with. \| \| virtual\_network\_tags list / elements=string \| \| The tags of VLAN Virtual Network Tag to associate the access group with. \| \| volumes list / elements=string \| \| List of volumes to initially include in the volume access group. If unspecified, the access group will start without any volumes. It accepts either volume\_name or volume\_id \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Create Access Group na_elementsw_access_group: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present name: AnsibleAccessGroup volumes: [7,8] account_id: 1 - name: Modify Access Group na_elementsw_access_group: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present name: AnsibleAccessGroup-Renamed account_id: 1 attributes: {"volumes": [1,2,3], "virtual_network_id": 12345} - name: Rename Access Group na_elementsw_access_group: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present from_name: AnsibleAccessGroup name: AnsibleAccessGroup-Renamed - name: Delete Access Group na_elementsw_access_group: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent name: 1 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#4e2029632f203d272c222b3a2b2f23686d7d7975686d7b7c75686d7a7675202b3a2f3e3e686d7a78752d2123)> ansible netapp.elementsw.na_elementsw_snapshot_restore – NetApp Element Software Restore Snapshot netapp.elementsw.na\_elementsw\_snapshot\_restore – NetApp Element Software Restore Snapshot ============================================================================================ Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_snapshot_restore`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Element OS Cluster restore snapshot to volume. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_id string / required \| \| Account ID or Name of Parent/Source Volume. \| \| dest\_volume\_name string / required \| \| New Name of destination for restoring the snapshot \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| src\_snapshot\_id string / required \| \| ID or Name of an existing snapshot. \| \| src\_volume\_id string / required \| \| ID or Name of source active volume. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Restore snapshot to volume tags: - elementsw_create_snapshot_restore na_elementsw_snapshot_restore: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" account_id: ansible-1 src_snapshot_id: snapshot_20171021 src_volume_id: volume-playarea dest_volume_name: dest-volume-area ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#e08e87cd818e9389828c859485818dc6c3d3d7dbc6c3d5d2dbc6c3d4d8db8e8594819090c6c3d4d6db838f8d)>	programming_docs
ansible netapp.elementsw.na_elementsw_volume_clone – NetApp Element Software Create Volume Clone netapp.elementsw.na\_elementsw\_volume\_clone – NetApp Element Software Create Volume Clone =========================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_volume_clone`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create volume clones on Element OS Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| access string \| Choices:* readOnly * readWrite * locked * replicationTarget \| Access allowed for the volume. If unspecified, the access settings of the clone will be the same as the source. readOnly - Only read operations are allowed. readWrite - Reads and writes are allowed. locked - No reads or writes are allowed. replicationTarget - Identify a volume as the target volume for a paired set of volumes. If the volume is not paired, the access status is locked. \| \| account\_id string / required \| \| Account ID for the owner of this cloned volume. id may be a numeric identifier or an account name. \| \| attributes dictionary \| \| A YAML dictionary of attributes that you would like to apply on this cloned volume. \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| name string / required \| \| The name of the clone. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| size integer \| \| The size of the cloned volume in (size\_unit). \| \| size\_unit string \| Choices:* bytes * b * kb * mb * gb ← * tb * pb * eb * zb * yb \| The unit used to interpret the size parameter. \| \| src\_snapshot\_id string \| \| The id of the snapshot to clone. id may be a numeric identifier or a snapshot name. \| \| src\_volume\_id string / required \| \| The id of the src volume to clone. id may be a numeric identifier or a volume name. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Clone Volume na_elementsw_volume_clone: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" name: CloneAnsibleVol src_volume_id: 123 src_snapshot_id: 41 account_id: 3 size: 1 size_unit: gb access: readWrite attributes: {"virtual_network_id": 12345} ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c6a8a1eba7a8b5afa4aaa3b2a3a7abe0e5f5f1fde0e5f3f4fde0e5f2fefda8a3b2a7b6b6e0e5f2f0fda5a9ab)> ansible netapp.elementsw.na_elementsw_account – NetApp Element Software Manage Accounts netapp.elementsw.na\_elementsw\_account – NetApp Element Software Manage Accounts ================================================================================= Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_account`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, destroy, or update accounts on Element SW Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| attributes dictionary \| \| List of Name/Value pairs in JSON object format. \| \| element\_username string / required \| \| Unique username for this account. (May be 1 to 64 characters in length). aliases: account\_id \| \| from\_name string added in 2.8.0 of netapp.elementsw \| \| ID or Name of the account to rename. Required to create an account called 'element\_username' by renaming 'from\_name'. \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| initiator\_secret string \| \| CHAP secret to use for the initiator. Should be 12-16 characters long and impenetrable. The CHAP initiator secrets must be unique and cannot be the same as the target CHAP secret. If not specified, a random secret is created. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified account should exist or not. \| \| status string \| \| Status of the account. \| \| target\_secret string \| \| CHAP secret to use for the target (mutual CHAP authentication). Should be 12-16 characters long and impenetrable. The CHAP target secrets must be unique and cannot be the same as the initiator CHAP secret. If not specified, a random secret is created. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Create Account na_elementsw_account: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present element_username: TenantA - name: Modify Account na_elementsw_account: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present status: locked element_username: TenantA - name: Rename Account na_elementsw_account: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present element_username: TenantA_Renamed from_name: TenantA - name: Rename and modify Account na_elementsw_account: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present status: locked element_username: TenantA_Renamed from_name: TenantA - name: Delete Account na_elementsw_account: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent element_username: TenantA_Renamed ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#28464f0549465b414a444d5c4d49450e0b1b1f130e0b1d1a130e0b1c1013464d5c4958580e0b1c1e134b4745)> ansible netapp.elementsw.na_elementsw_snapshot_schedule – NetApp Element Software Snapshot Schedules netapp.elementsw.na\_elementsw\_snapshot\_schedule – NetApp Element Software Snapshot Schedules =============================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_snapshot_schedule`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, destroy, or update snapshot schedules on ElementSW Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_id string \| \| Account ID for the owner of this volume. It accepts either account\_name or account\_id if account\_id is digit, it will consider as account\_id If account\_id is string, it will consider as account\_name \| \| days\_of\_month\_hours integer \| \| Time specified in hours \| \| days\_of\_month\_minutes integer \| \| Time specified in minutes. \| \| days\_of\_month\_monthdays list / elements=integer \| \| List of days of the month (1-31) \| \| days\_of\_week\_hours integer \| \| Time specified in hours \| \| days\_of\_week\_minutes integer \| \| Time specified in minutes. \| \| days\_of\_week\_weekdays list / elements=string \| \| List of days of the week (Sunday to Saturday) \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| name string / required \| \| Name for the snapshot schedule. It accepts either schedule\_id or schedule\_name if name is digit, it will consider as schedule\_id If name is string, it will consider as schedule\_name \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| paused boolean \| Choices:* no * yes \| Pause / Resume a schedule. \| \| recurring boolean \| Choices:* no * yes \| Should the schedule recur? \| \| retention string \| \| Retention period for the snapshot. Format is 'HH:mm:ss'. \| \| schedule\_type string \| Choices:* DaysOfWeekFrequency * DaysOfMonthFrequency * TimeIntervalFrequency \| Schedule type for creating schedule. \| \| snapshot\_name string \| \| Name for the created snapshots. \| \| starting\_date string \| \| Starting date for the schedule. Required when `state=present`. Format: `2016-12-01T00:00:00Z` \| \| state string \| Choices:* present ← * absent \| Whether the specified schedule should exist or not. \| \| time\_interval\_days integer \| \| Time interval in days. \| \| time\_interval\_hours integer \| \| Time interval in hours. \| \| time\_interval\_minutes integer \| \| Time interval in minutes. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| \| volumes list / elements=string \| \| Volume IDs that you want to set the snapshot schedule for. It accepts both volume\_name and volume\_id \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Create Snapshot schedule na_elementsw_snapshot_schedule: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present name: Schedule_A schedule_type: TimeIntervalFrequency time_interval_days: 1 starting_date: '2016-12-01T00:00:00Z' retention: '24:00:00' volumes: - 7 - test account_id: 1 - name: Update Snapshot schedule na_elementsw_snapshot_schedule: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present name: Schedule_A schedule_type: TimeIntervalFrequency time_interval_days: 1 starting_date: '2016-12-01T00:00:00Z' retention: '24:00:00' volumes: - 8 - test1 account_id: 1 - name: Delete Snapshot schedule na_elementsw_snapshot_schedule: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent name: 6 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| schedule\_id string \| success \| Schedule ID of the newly created schedule \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#650b0248040b160c07090011000408434656525e434650575e4346515d5e0b0011041515434651535e060a08)> ansible netapp.elementsw.na_elementsw_initiators – Manage Element SW initiators netapp.elementsw.na\_elementsw\_initiators – Manage Element SW initiators ========================================================================= Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_initiators`. New in version 2.8.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage Element Software initiators that allow external clients access to volumes. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| initiators list / elements=dictionary \| \| A list of objects containing characteristics of each initiator. \| \| \| alias string \| \| The friendly name assigned to this initiator. \| \| \| attributes dictionary \| \| A set of JSON attributes to assign to this initiator. \| \| \| initiator\_id integer \| \| The numeric ID of the initiator. \| \| \| name string / required \| \| The name of the initiator. \| \| \| volume\_access\_group\_id integer \| \| volumeAccessGroupID to which this initiator belongs. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified initiator should exist or not. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Manage initiators tags: - na_elementsw_initiators na_elementsw_initiators: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" initiators: - name: a alias: a1 initiator_id: 1 volume_access_group_id: 1 attributes: {"key": "value"} - name: b alias: b2 initiator_id: 2 volume_access_group_id: 2 state: present ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b9d7de94d8d7cad0dbd5dccddcd8d49f9a8a8e829f9a8c8b829f9a8d8182d7dccdd8c9c99f9a8d8f82dad6d4)> ansible netapp.elementsw.na_elementsw_check_connections – NetApp Element Software Check connectivity to MVIP and SVIP. netapp.elementsw.na\_elementsw\_check\_connections – NetApp Element Software Check connectivity to MVIP and SVIP. ================================================================================================================= Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_check_connections`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Used to test the management connection to the cluster. * The test pings the MVIP and SVIP, and executes a simple API method to verify connectivity. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| mvip string \| \| Optionally, use to test connection of a different MVIP. This is not needed to test the connection to the target cluster. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| skip string \| Choices:* svip * mvip \| Skip checking connection to SVIP or MVIP. \| \| svip string \| \| Optionally, use to test connection of a different SVIP. This is not needed to test the connection to the target cluster. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Check connections to MVIP and SVIP na_elementsw_check_connections: hostname: "{{ solidfire_hostname }}" username: "{{ solidfire_username }}" password: "{{ solidfire_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#cfa1a8e2aea1bca6ada3aabbaaaea2e9ecfcf8f4e9ecfafdf4e9ecfbf7f4a1aabbaebfbfe9ecfbf9f4aca0a2)>	programming_docs
ansible netapp.elementsw.na_elementsw_volume – NetApp Element Software Manage Volumes netapp.elementsw.na\_elementsw\_volume – NetApp Element Software Manage Volumes =============================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_volume`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, destroy, or update volumes on ElementSW Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| access string \| Choices:* readOnly * readWrite * locked * replicationTarget \| Access allowed for the volume. readOnly Only read operations are allowed. readWrite Reads and writes are allowed. locked No reads or writes are allowed. replicationTarget Identify a volume as the target volume for a paired set of volumes. If the volume is not paired, the access status is locked. If unspecified, the access settings of the clone will be the same as the source. \| \| account\_id string / required \| \| Account ID for the owner of this volume. It accepts Account\_id or Account\_name \| \| attributes dictionary \| \| A YAML dictionary of attributes that you would like to apply on this volume. \| \| enable512e boolean \| Choices:* no * yes \| Required when `state=present` Should the volume provide 512-byte sector emulation? aliases: enable512emulation \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| name string / required \| \| The name of the volume to manage. It accepts volume\_name or volume\_id \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| qos dictionary \| \| Initial quality of service settings for this volume. Configure as dict in playbooks. \| \| qos\_policy\_name string \| \| Quality of service policy for this volume. It can be a name or an id. Mutually exclusive with `qos` option. \| \| size integer \| \| The size of the volume in (size\_unit). Required when `state = present`. \| \| size\_unit string \| Choices:* bytes * b * kb * mb * gb ← * tb * pb * eb * zb * yb \| The unit used to interpret the size parameter. \| \| state string \| Choices:* present ← * absent \| Whether the specified volume should exist or not. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Create Volume na_elementsw_volume: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present name: AnsibleVol qos: {minIOPS: 1000, maxIOPS: 20000, burstIOPS: 50000} account_id: 3 enable512e: False size: 1 size_unit: gb - name: Update Volume na_elementsw_volume: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present name: AnsibleVol account_id: 3 access: readWrite - name: Delete Volume na_elementsw_volume: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent name: AnsibleVol account_id: 2 ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f59b92d8949b869c97999081909498d3d6c6c2ced3d6c0c7ced3d6c1cdce9b9081948585d3d6c1c3ce969a98)> ansible netapp.elementsw.na_elementsw_vlan – NetApp Element Software Manage VLAN netapp.elementsw.na\_elementsw\_vlan – NetApp Element Software Manage VLAN ========================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_vlan`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, delete, modify VLAN Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address\_blocks list / elements=dictionary \| \| List of address blocks for the VLAN Each address block contains the starting IP address and size for the block Required for create \| \| attributes dictionary \| \| Dictionary of attributes with name and value for each attribute \| \| gateway string \| \| Gateway for the VLAN \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| name string \| \| User defined name for the new VLAN Name of the vlan is unique Required for create \| \| namespace boolean \| Choices:* no * yes \| Enable or disable namespaces \| \| netmask string \| \| Netmask for the VLAN Required for create \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| state string \| Choices:* present ← * absent \| Whether the specified vlan should exist or not. \| \| svip string \| \| Storage virtual IP which is unique Required for create \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| \| vlan\_tag string / required \| \| Virtual Network Tag \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Create vlan na_elementsw_vlan: state: present name: test vlan_tag: 1 svip: "{{ ip address }}" netmask: "{{ netmask }}" address_blocks: - start: "{{ starting ip_address }}" size: 5 - start: "{{ starting ip_address }}" size: 5 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" - name: Delete Lun na_elementsw_vlan: state: absent vlan_tag: 1 hostname: "{{ netapp_hostname }}" username: "{{ netapp_username }}" password: "{{ netapp_password }}" ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#e38d84ce828d908a818f869786828ec5c0d0d4d8c5c0d6d1d8c5c0d7dbd88d8697829393c5c0d7d5d8808c8e)> ansible netapp.elementsw.na_elementsw_snapshot – NetApp Element Software Manage Snapshots netapp.elementsw.na\_elementsw\_snapshot – NetApp Element Software Manage Snapshots =================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_snapshot`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, Modify or Delete Snapshot on Element OS Cluster. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_id string / required \| \| Account ID or Name of Parent/Source Volume. \| \| enable\_remote\_replication boolean \| Choices:* no * yes \| Flag, whether to replicate the snapshot created to a remote replication cluster. To enable specify 'true' value. \| \| expiration\_time string \| \| The date and time (format ISO 8601 date string) at which this snapshot will expire. \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| name string \| \| Name of new snapshot create. If unspecified, date and time when the snapshot was taken is used. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| retention string \| \| Retention period for the snapshot. Format is 'HH:mm:ss'. \| \| snap\_mirror\_label string \| \| Label used by SnapMirror software to specify snapshot retention policy on SnapMirror endpoint. \| \| src\_snapshot\_id string \| \| ID or Name of an existing snapshot. Required when `state=present`, to modify snapshot properties. Required when `state=present`, to create snapshot from another snapshot in the volume. Required when `state=absent`, to delete snapshot. \| \| src\_volume\_id string / required \| \| ID or Name of active volume. \| \| state string \| Choices:* present ← * absent \| Whether the specified snapshot should exist or not. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Create snapshot tags: - elementsw_create_snapshot na_elementsw_snapshot: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present src_volume_id: 118 account_id: sagarsh name: newsnapshot-1 - name: Modify Snapshot tags: - elementsw_modify_snapshot na_elementsw_snapshot: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present src_volume_id: sagarshansivolume src_snapshot_id: test1 account_id: sagarsh expiration_time: '2018-06-16T12:24:56Z' enable_remote_replication: false - name: Delete Snapshot tags: - elementsw_delete_snapshot na_elementsw_snapshot: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent src_snapshot_id: deltest1 account_id: sagarsh src_volume_id: sagarshansivolume ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#7e1019531f100d171c121b0a1b1f13585d4d4945585d4b4c45585d4a4645101b0a1f0e0e585d4a48451d1113)> ansible netapp.elementsw.na_elementsw_network_interfaces – NetApp Element Software Configure Node Network Interfaces netapp.elementsw.na\_elementsw\_network\_interfaces – NetApp Element Software Configure Node Network Interfaces =============================================================================================================== Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_network_interfaces`. New in version 2.7.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Configure Element SW Node Network Interfaces for Bond 1G and 10G IP addresses. * This module does not create interfaces, it expects the interfaces to already exists and can only modify them. * This module cannot set or modify the method (Loopback, manual, dhcp, static). * This module is not idempotent and does not support check\_mode. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bond\_10g dictionary \| \| settings for the Bond10G interface. \| \| \| address string \| \| IP address for the interface. \| \| \| bond\_lacp\_rate string \| Choices:* Fast * Slow \| Link Aggregation Control Protocol - useful only if LACP is selected as the Bond Mode. Slow - Packets are transmitted at 30 second intervals. Fast - Packets are transmitted in 1 second intervals. \| \| \| bond\_mode string \| Choices:* ActivePassive * ALB * LACP \| Bonding mode. \| \| \| dns\_nameservers list / elements=string \| \| List of addresses for domain name servers. \| \| \| dns\_search list / elements=string \| \| List of DNS search domains. \| \| \| gateway string \| \| IP router network address to send packets out of the local network. \| \| \| mtu string \| \| The largest packet size (in bytes) that the interface can transmit.. Must be greater than or equal to 1500 bytes. \| \| \| netmask string \| \| subnet mask for the interface. \| \| \| virtual\_network\_tag string \| \| The virtual network identifier of the interface (VLAN tag). \| \| bond\_1g dictionary \| \| settings for the Bond1G interface. \| \| \| address string \| \| IP address for the interface. \| \| \| bond\_lacp\_rate string \| Choices:* Fast * Slow \| Link Aggregation Control Protocol - useful only if LACP is selected as the Bond Mode. Slow - Packets are transmitted at 30 second intervals. Fast - Packets are transmitted in 1 second intervals. \| \| \| bond\_mode string \| Choices:* ActivePassive * ALB * LACP \| Bonding mode. \| \| \| dns\_nameservers list / elements=string \| \| List of addresses for domain name servers. \| \| \| dns\_search list / elements=string \| \| List of DNS search domains. \| \| \| gateway string \| \| IP router network address to send packets out of the local network. \| \| \| mtu string \| \| The largest packet size (in bytes) that the interface can transmit.. Must be greater than or equal to 1500 bytes. \| \| \| netmask string \| \| subnet mask for the interface. \| \| \| virtual\_network\_tag string \| \| The virtual network identifier of the interface (VLAN tag). \| \| bond\_mode\_10g string \| \| deprecated, use bond\_10g option. \| \| bond\_mode\_1g string \| \| deprecated, use bond\_1g option. \| \| dns\_nameservers list / elements=string \| \| deprecated, use bond\_1g and bond\_10g options. \| \| dns\_search\_domains list / elements=string \| \| deprecated, use bond\_1g and bond\_10g options. \| \| gateway\_address\_10g string \| \| deprecated, use bond\_10g option. \| \| gateway\_address\_1g string \| \| deprecated, use bond\_1g option. \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| ip\_address\_10g string \| \| deprecated, use bond\_10g option. \| \| ip\_address\_1g string \| \| deprecated, use bond\_1g option. \| \| lacp\_10g string \| \| deprecated, use bond\_10g option. \| \| lacp\_1g string \| \| deprecated, use bond\_1g option. \| \| method string \| \| deprecated, this option would trigger a 'updated failed' error \| \| mtu\_10g string \| \| deprecated, use bond\_10g option. \| \| mtu\_1g string \| \| deprecated, use bond\_1g option. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| subnet\_10g string \| \| deprecated, use bond\_10g option. \| \| subnet\_1g string \| \| deprecated, use bond\_1g option. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| \| virtual\_network\_tag string \| \| deprecated, use bond\_1g and bond\_10g options. \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: Set Node network interfaces configuration for Bond 1G and 10G properties tags: - elementsw_network_interfaces na_elementsw_network_interfaces: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" bond_1g: address: 10.253.168.131 netmask: 255.255.248.0 gateway: 10.253.168.1 mtu: '1500' bond_mode: ActivePassive dns_nameservers: dns1,dns2 dns_search: domain1,domain2 bond_10g: address: 10.253.1.202 netmask: 255.255.255.192 gateway: 10.253.1.193 mtu: '9000' bond_mode: LACP bond_lacp_rate: Fast virtual_network_tag: vnet_tag ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#a6c8c18bc7c8d5cfc4cac3d2c3c7cb808595919d808593949d8085929e9dc8c3d2c7d6d6808592909dc5c9cb)>	programming_docs
ansible netapp.elementsw.na_elementsw_cluster_snmp – Configure Element SW Cluster SNMP netapp.elementsw.na\_elementsw\_cluster\_snmp – Configure Element SW Cluster SNMP ================================================================================= Note This plugin is part of the [netapp.elementsw collection](https://galaxy.ansible.com/netapp/elementsw) (version 21.6.1). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.elementsw`. To use it in a playbook, specify: `netapp.elementsw.na_elementsw_cluster_snmp`. New in version 2.8.0: of netapp.elementsw * [Synopsis](#synopsis) * [Requirements](#requirements) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Configure Element Software cluster SNMP. Requirements ------------ The below requirements are needed on the host that executes this module. * The modules were developed with SolidFire 10.1 * solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’ Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| hostname string / required \| \| The hostname or IP address of the SolidFire cluster. For na\_elementsw\_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from. \| \| networks dictionary \| \| List of networks and what type of access they have to the SNMP servers running on the cluster nodes. This parameter is required if SNMP v3 is disabled. \| \| \| access string \| Choices:* ro * rw * rosys \| ro for read-only access. rw for read-write access. rosys for read-only access to a restricted set of system information. \| \| \| cidr integer \| \| A CIDR network mask. This network mask must be an integer greater than or equal to 0, and less than or equal to 32. It must also not be equal to 31. \| \| \| community string \| \| SNMP community string. \| \| \| network string \| \| This parameter along with the cidr variable is used to control which network the access and community string apply to. The special value of 'default' is used to specify an entry that applies to all networks. The cidr mask is ignored when network value is either a host name or default. \| \| password string / required \| \| Password for the specified user. aliases: pass \| \| snmp\_v3\_enabled boolean \| Choices:* no * yes \| Which version of SNMP has to be enabled. \| \| state string \| Choices:* present ← * absent \| This module enables you to enable SNMP on cluster nodes. When you enable SNMP, the action applies to all nodes in the cluster, and the values that are passed replace, in whole, all values set in any previous call to this module. \| \| username string / required \| \| Please ensure that the user has the adequate permissions. For more information, please read the official documentation <https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US>. aliases: user \| \| usm\_users dictionary \| \| List of users and the type of access they have to the SNMP servers running on the cluster nodes. This parameter is required if SNMP v3 is enabled. \| \| \| access string \| Choices:* rouser * rwuser * rosys \| rouser for read-only access. rwuser for read-write access. rosys for read-only access to a restricted set of system information. \| \| \| name string \| \| The name of the user. Must contain at least one character, but no more than 32 characters. Blank spaces are not allowed. \| \| \| passphrase string \| \| The passphrase of the user. Must be between 8 and 255 characters long (inclusive). Blank spaces are not allowed. Required if 'secLevel' is 'priv.' \| \| \| password string \| \| The password of the user. Must be between 8 and 255 characters long (inclusive). Blank spaces are not allowed. Required if 'secLevel' is 'auth' or 'priv.' \| \| \| secLevel string \| Choices:* noauth * auth * priv \| To define the security level of a user. \| Notes ----- Note * The modules prefixed with na\\_elementsw are built to support the SolidFire storage platform. Examples -------- ``` - name: configure SnmpNetwork tags: - elementsw_cluster_snmp na_elementsw_cluster_snmp: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: present snmp_v3_enabled: True usm_users: access: rouser name: testuser password: ChangeMe123 passphrase: ChangeMe123 secLevel: auth networks: access: ro cidr: 24 community: TestNetwork network: 192.168.0.1 - name: Disable SnmpNetwork tags: - elementsw_cluster_snmp na_elementsw_cluster_snmp: hostname: "{{ elementsw_hostname }}" username: "{{ elementsw_username }}" password: "{{ elementsw_password }}" state: absent ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f79990da9699849e959b928392969ad1d4c4c0ccd1d4c2c5ccd1d4c3cfcc999283968787d1d4c3c1cc94989a)> ansible Netapp.Aws Netapp.Aws ========== Collection version 21.6.0 Plugin Index ------------ These are the plugins in the netapp.aws collection ### Modules * [aws\_netapp\_cvs\_active\_directory](aws_netapp_cvs_active_directory_module#ansible-collections-netapp-aws-aws-netapp-cvs-active-directory-module) – NetApp AWS CloudVolumes Service Manage Active Directory. * [aws\_netapp\_cvs\_filesystems](aws_netapp_cvs_filesystems_module#ansible-collections-netapp-aws-aws-netapp-cvs-filesystems-module) – NetApp AWS Cloud Volumes Service Manage FileSystem. * [aws\_netapp\_cvs\_pool](aws_netapp_cvs_pool_module#ansible-collections-netapp-aws-aws-netapp-cvs-pool-module) – NetApp AWS Cloud Volumes Service Manage Pools. * [aws\_netapp\_cvs\_snapshots](aws_netapp_cvs_snapshots_module#ansible-collections-netapp-aws-aws-netapp-cvs-snapshots-module) – NetApp AWS Cloud Volumes Service Manage Snapshots. See also List of [collections](../../index#list-of-collections) with docs hosted here. ansible netapp.aws.aws_netapp_cvs_pool – NetApp AWS Cloud Volumes Service Manage Pools. netapp.aws.aws\_netapp\_cvs\_pool – NetApp AWS Cloud Volumes Service Manage Pools. ================================================================================== Note This plugin is part of the [netapp.aws collection](https://galaxy.ansible.com/netapp/aws) (version 21.6.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.aws`. To use it in a playbook, specify: `netapp.aws.aws_netapp_cvs_pool`. New in version 2.9.0: of netapp.aws * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, Update, Delete Pool on AWS Cloud Volumes Service. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_key string / required \| \| The access key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| api\_url string / required \| \| The url to the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| feature\_flags dictionary added in 21.6.0 of netapp.aws \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| from\_name string \| \| rename the existing pool name ( The human readable name of the Pool ) from\_name is the existing name, and name the new name can be used with update operation \| \| name string / required \| \| pool name ( The human readable name of the Pool ) name can be used for create, update and delete operations \| \| region string / required \| \| The region to which the Pool is associated. \| \| secret\_key string / required \| \| The secret\_key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| serviceLevel string \| Choices:* basic * standard * extreme \| The service level of the Pool can be used with pool create, update operations \| \| sizeInBytes integer \| \| Size of the Pool in bytes can be used with pool create, update operations minimum value is 4000000000000 bytes \| \| state string / required \| Choices:* present * absent \| Whether the specified pool should exist or not. \| \| validate\_certs boolean \| Choices:* no * yes ← \| Should https certificates be validated? \| \| vendorID string \| \| A vendor ID for the Pool. E.g. an ID allocated by a vendor service for the Pool. can be used with pool create, update operations must be unique \| Notes ----- Note * The modules prefixed with aws\_cvs\_netapp are built to Manage AWS Cloud Volumes Service . Examples -------- ``` - name: Create a new Pool aws_netapp_cvs_pool: state: present name: TestPoolBB12 serviceLevel: extreme sizeInBytes: 4000000000000 vendorID: ansiblePoolTestVendorBB12 region: us-east-1 api_url: cds-aws-bundles.netapp.com api_key: MyAPiKey secret_key: MySecretKey - name: Delete a Pool aws_netapp_cvs_pool: state: absent name: TestPoolBB7 region: us-east-1 api_url: cds-aws-bundles.netapp.com api_key: MyAPiKey secret_key: MySecretKey - name: Update a Pool aws_netapp_cvs_pool: state: present from_name: TestPoolBB12 name: Mynewpool7 vendorID: ansibleVendorMynewpool15 serviceLevel: extreme sizeInBytes: 4000000000000 region: us-east-1 api_url: cds-aws-bundles.netapp.com api_key: MyAPiKey secret_key: MySecretKey ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1d737a307c736e747f717869787c703b3e2e2a263b3e282f263b3e2925267378697c6d6d3b3e292b267e7270)> ansible netapp.aws.aws_netapp_cvs_snapshots – NetApp AWS Cloud Volumes Service Manage Snapshots. netapp.aws.aws\_netapp\_cvs\_snapshots – NetApp AWS Cloud Volumes Service Manage Snapshots. =========================================================================================== Note This plugin is part of the [netapp.aws collection](https://galaxy.ansible.com/netapp/aws) (version 21.6.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.aws`. To use it in a playbook, specify: `netapp.aws.aws_netapp_cvs_snapshots`. New in version 2.9.0: of netapp.aws * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, Update, Delete Snapshot on AWS Cloud Volumes Service. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_key string / required \| \| The access key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| api\_url string / required \| \| The url to the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| feature\_flags dictionary added in 21.6.0 of netapp.aws \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| fileSystemId string \| \| Name or Id of the filesystem. Required for create operation \| \| from\_name string \| \| ID or Name of the snapshot to rename. Required to create an snapshot called 'name' by renaming 'from\_name'. \| \| name string / required \| \| Name of the snapshot \| \| region string / required \| \| The region to which the snapshot belongs to. \| \| secret\_key string / required \| \| The secret\_key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| state string / required \| Choices:* present * absent \| Whether the specified snapshot should exist or not. \| \| validate\_certs boolean \| Choices:* no * yes ← \| Should https certificates be validated? \| Notes ----- Note * The modules prefixed with aws\_cvs\_netapp are built to Manage AWS Cloud Volumes Service . Examples -------- ``` - name: Create Snapshot aws_netapp_cvs_snapshots: state: present region: us-east-1 name: testSnapshot fileSystemId: testVolume api_url : cds-aws-bundles.netapp.com api_key: myApiKey secret_key : mySecretKey - name: Update Snapshot aws_netapp_cvs_snapshots: state: present region: us-east-1 name: testSnapshot - renamed from_name: testSnapshot fileSystemId: testVolume api_url : cds-aws-bundles.netapp.com api_key: myApiKey secret_key : mySecretKey - name: Delete Snapshot aws_netapp_cvs_snapshots: state: absent region: us-east-1 name: testSnapshot api_url : cds-aws-bundles.netapp.com api_key: myApiKey secret_key : mySecretKey ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f9979ed498978a909b959c8d9c9894dfdacacec2dfdacccbc2dfdacdc1c2979c8d988989dfdacdcfc29a9694)> ansible netapp.aws.aws_netapp_cvs_active_directory – NetApp AWS CloudVolumes Service Manage Active Directory. netapp.aws.aws\_netapp\_cvs\_active\_directory – NetApp AWS CloudVolumes Service Manage Active Directory. ========================================================================================================= Note This plugin is part of the [netapp.aws collection](https://galaxy.ansible.com/netapp/aws) (version 21.6.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.aws`. To use it in a playbook, specify: `netapp.aws.aws_netapp_cvs_active_directory`. New in version 2.9.0: of netapp.aws * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, Update, Delete ActiveDirectory on AWS Cloud Volumes Service. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_key string / required \| \| The access key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| api\_url string / required \| \| The url to the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| DNS string \| \| DNS server address for the Active Directory domain Required when `state=present` Required when `state=present`, to modify ActiveDirectory properties. \| \| domain string \| \| Name of the Active Directory domain \| \| feature\_flags dictionary added in 21.6.0 of netapp.aws \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| netBIOS string \| \| NetBIOS name of the server. \| \| password string \| \| Password of the Active Directory domain administrator Required when `state=present`, to modify ActiveDirectory properties \| \| region string / required \| \| The region to which the Active Directory credentials are associated. \| \| secret\_key string / required \| \| The secret\_key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| state string / required \| Choices:* present * absent \| Whether the specified ActiveDirectory should exist or not. \| \| username string \| \| Username of the Active Directory domain administrator \| \| validate\_certs boolean \| Choices:* no * yes ← \| Should https certificates be validated? \| Notes ----- Note * The modules prefixed with aws\_cvs\_netapp are built to Manage AWS Cloud Volumes Service . Examples -------- ``` - name: Create Active Directory aws_netapp_cvs_active_directory.py: state: present region: us-east-1 DNS: 101.102.103.123 domain: mydomain.com password: netapp1! netBIOS: testing username: user1 api_url : My_CVS_Hostname api_key: My_API_Key secret_key : My_Secret_Key - name: Update Active Directory aws_netapp_cvs_active_directory.py: state: present region: us-east-1 DNS: 101.102.103.123 domain: mydomain.com password: netapp2! netBIOS: testingBIOS username: user2 api_url : My_CVS_Hostname api_key: My_API_Key secret_key : My_Secret_Key - name: Delete Active Directory aws_netapp_cvs_active_directory.py: state: absent region: us-east-1 domain: mydomain.com api_url : My_CVS_Hostname api_key: My_API_Key secret_key : My_Secret_Key ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#204e470d414e5349424c455445414d060313171b060315121b060314181b4e4554415050060314161b434f4d)> ansible netapp.aws.aws_netapp_cvs_filesystems – NetApp AWS Cloud Volumes Service Manage FileSystem. netapp.aws.aws\_netapp\_cvs\_filesystems – NetApp AWS Cloud Volumes Service Manage FileSystem. ============================================================================================== Note This plugin is part of the [netapp.aws collection](https://galaxy.ansible.com/netapp/aws) (version 21.6.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.aws`. To use it in a playbook, specify: `netapp.aws.aws_netapp_cvs_filesystems`. New in version 2.9.0: of netapp.aws * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, Update, Delete fileSystem on AWS Cloud Volumes Service. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| api\_key string / required \| \| The access key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| api\_url string / required \| \| The url to the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| creationToken string / required \| \| Name of the filesystem \| \| exportPolicy dictionary \| \| The policy rules to export the filesystem \| \| \| rules list / elements=dictionary \| \| Set of rules to export the filesystem Requires allowedClients, access and protocol \| \| \| \| allowedClients string \| \| Comma separated list of ip address blocks of the clients to access the fileSystem Each address block contains the starting IP address and size for the block \| \| \| \| cifs boolean \| Choices:* no * yes \| Enable or disable cifs filesystem \| \| \| \| nfsv3 boolean \| Choices:* no * yes \| Enable or disable nfsv3 fileSystem \| \| \| \| nfsv4 boolean \| Choices:* no * yes \| Enable or disable nfsv4 filesystem \| \| \| \| ruleIndex integer \| \| Index number of the rule \| \| \| \| unixReadOnly boolean \| Choices:* no * yes \| Should fileSystem have read only permission or not \| \| \| \| unixReadWrite boolean \| Choices:* no * yes \| Should fileSystem have read write permission or not \| \| feature\_flags dictionary added in 21.6.0 of netapp.aws \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. trace\_apis can be set to true to enable tracing, data is written to /tmp/um\_apis.log. \| \| quotaInBytes integer \| \| Size of the filesystem Required for create \| \| region string / required \| \| The region to which the filesystem belongs to. \| \| secret\_key string / required \| \| The secret\_key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API. \| \| serviceLevel string \| Choices:* standard * premium * extreme \| Service Level of a filesystem. \| \| state string / required \| Choices:* present * absent \| Whether the specified fileSystem should exist or not. \| \| validate\_certs boolean \| Choices:* no * yes ← \| Should https certificates be validated? \| Notes ----- Note * The modules prefixed with aws\_cvs\_netapp are built to Manage AWS Cloud Volumes Service . Examples -------- ``` - name: Create FileSystem aws_netapp_cvs_filesystems: state: present region: us-east-1 creationToken: newVolume-1 exportPolicy: rules: - allowedClients: 172.16.0.4 cifs: False nfsv3: True nfsv4: True ruleIndex: 1 unixReadOnly: True unixReadWrite: False quotaInBytes: 100000000000 api_url : cds-aws-bundles.netapp.com:8080 api_key: My_API_Key secret_key : My_Secret_Key - name: Update FileSystem aws_netapp_cvs_filesystems: state: present region: us-east-1 creationToken: newVolume-1 exportPolicy: rules: - allowedClients: 172.16.0.4 cifs: False nfsv3: True nfsv4: True ruleIndex: 1 unixReadOnly: True unixReadWrite: False quotaInBytes: 200000000000 api_url : cds-aws-bundles.netapp.com:8080 api_key: My_API_Key secret_key : My_Secret_Key - name: Delete FileSystem aws_netapp_cvs_filesystems: state: present region: us-east-1 creationToken: newVolume-1 quotaInBytes: 100000000000 api_url : cds-aws-bundles.netapp.com:8080 api_key: My_API_Key secret_key : My_Secret_Key ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b3ddd49ed2ddc0dad1dfd6c7d6d2de959080848895908681889590878b88ddd6c7d2c3c39590878588d0dcde)>	programming_docs
ansible netapp.cloudmanager.na_cloudmanager_nss_account – NetApp Cloud Manager nss account netapp.cloudmanager.na\_cloudmanager\_nss\_account – NetApp Cloud Manager nss account ===================================================================================== Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_nss_account`. New in version 21.3.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create and Delete nss account. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| name string \| \| The name of the NSS account. \| \| password string \| \| The NSS password. \| \| public\_id string \| \| The ID of the NSS account. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| state string \| Choices:* present ← * absent \| Whether the specified nss account should exist or not. \| \| username string / required \| \| The NSS username. \| \| vsa\_list list / elements=string \| \| The working environment list. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create nss account netapp.cloudmanager.na_cloudmanager_nss_account: state: present name: test_cloud username: test_cloud password: password client_id: your_client_id refresh_token: your_refresh_token ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#d3bdb4feb2bda0bab1bfb6a7b6b2bef5f0e0e4e8f5f0e6e1e8f5f0e7ebe8bdb6a7b2a3a3f5f0e7e5e8b0bcbe)> ansible netapp.cloudmanager.na_cloudmanager_volume – NetApp Cloud Manager volume netapp.cloudmanager.na\_cloudmanager\_volume – NetApp Cloud Manager volume ========================================================================== Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_volume`. New in version 21.3.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create, Modify or Delete volume on Cloud Manager. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| aggregate\_name string \| \| The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate. \| \| capacity\_tier string \| Choices:* NONE * S3 * Blob * cloudStorage \| The volume's capacity tier for tiering cold data to object storage. The default values for each cloud provider are as follows. Amazon as 'S3', Azure as 'Blob', GCP as 'cloudStorage'. If 'NONE', the capacity tier will not be set on volume creation. \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. \| \| enable\_compression boolean \| Choices:* no * yes \| Enabling cpmpression. Default to true if not specified. \| \| enable\_deduplication boolean \| Choices:* no * yes \| Enabling deduplication. Default to true if not specified. \| \| enable\_thin\_provisioning boolean \| Choices:* no * yes \| Enabling thin provisioning. Default to true if not specified. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| export\_policy\_ip list / elements=string \| \| Custom export policy list of IPs (NFS protocol parameters). \| \| export\_policy\_nfs\_version list / elements=string \| \| Export policy protocol (NFS protocol parameters). \| \| export\_policy\_type string \| \| The export policy type (NFS protocol parameters). \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| igroups list / elements=string \| \| List of igroups (iSCSI protocol parameters). \| \| initiators list / elements=dictionary \| \| Set of attributes of Initiators (iSCSI protocol parameters). \| \| \| alias string / required \| \| The alias which associates with the node. \| \| \| iqn string / required \| \| The initiator node name. \| \| iops integer \| \| Provisioned IOPS. Needed only when provider\_volume\_type is "io1". \| \| name string / required \| \| The name of the volume. \| \| os\_name string \| \| Operating system (iSCSI protocol parameters). \| \| permission string \| \| CIFS share permission type (CIFS protocol parameters). \| \| provider\_volume\_type string \| \| The underlying cloud provider volume type. For AWS is ["gp3", "gp2", "io1", "st1", "sc1"]. For Azure is ['Premium\_LRS','Standard\_LRS','StandardSSD\_LRS']. For GCP is ['pd-balanced','pd-ssd','pd-standard']. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| share\_name string \| \| Share name (CIFS protocol parameters). \| \| size float \| \| The size of the volume. \| \| size\_unit string \| Choices:* GB ← \| The size unit of volume. \| \| snapshot\_policy\_name string \| \| The snapshot policy name. \| \| state string \| Choices:* present ← * absent \| Whether the specified volume should exist or not. \| \| svm\_name string \| \| The name of the SVM. The default SVM name is used, if a name is not provided. \| \| throughput integer \| \| Unit is Mb/s. Valid range 125-1000. Required only when provider\_volume\_type is 'gp3'. \| \| tiering\_policy string \| Choices:* none * snapshot\_only * auto * all \| The tiering policy. \| \| users list / elements=string \| \| List of users with the permission (CIFS protocol parameters). \| \| volume\_protocol string \| Choices:* nfs ← * cifs * iscsi \| The protocol for the volume. This affects the provided parameters. \| \| working\_environment\_id string \| \| The public ID of the working environment where the volume will be created. \| \| working\_environment\_name string \| \| The working environment name where the volume will be created. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create nfs volume with working_environment_name netapp.cloudmanager.na_cloudmanager_volume: state: present name: test_vol size: 15 size_unit: GB working_environment_name: working_environment_1 client_id: client_id refresh_token: refresh_token svm_name: svm_1 snapshot_policy_name: default export_policy_type: custom export_policy_ip: ["10.0.0.1/16"] export_policy_nfs_version: ["nfs3","nfs4"] - name: Delete volume netapp.cloudmanager.na_cloudmanager_volume: state: absent name: test_vol working_environment_name: working_environment_1 client_id: client_id refresh_token: refresh_token svm_name: svm_1 ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c9a7aee4a8a7baa0aba5acbdaca8a4efeafafef2efeafcfbf2efeafdf1f2a7acbda8b9b9efeafdfff2aaa6a4)> ansible Netapp.Cloudmanager Netapp.Cloudmanager =================== Collection version 21.11.0 Plugin Index ------------ These are the plugins in the netapp.cloudmanager collection ### Modules * [na\_cloudmanager\_aggregate](na_cloudmanager_aggregate_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-aggregate-module) – NetApp Cloud Manager Aggregate * [na\_cloudmanager\_cifs\_server](na_cloudmanager_cifs_server_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-cifs-server-module) – NetApp Cloud Manager cifs server * [na\_cloudmanager\_connector\_aws](na_cloudmanager_connector_aws_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-connector-aws-module) – NetApp Cloud Manager connector for AWS * [na\_cloudmanager\_connector\_azure](na_cloudmanager_connector_azure_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-connector-azure-module) – NetApp Cloud Manager connector for Azure. * [na\_cloudmanager\_connector\_gcp](na_cloudmanager_connector_gcp_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-connector-gcp-module) – NetApp Cloud Manager connector for GCP. * [na\_cloudmanager\_cvo\_aws](na_cloudmanager_cvo_aws_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-cvo-aws-module) – NetApp Cloud Manager CVO for AWS * [na\_cloudmanager\_cvo\_azure](na_cloudmanager_cvo_azure_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-cvo-azure-module) – NetApp Cloud Manager CVO/working environment in single or HA mode for Azure. * [na\_cloudmanager\_cvo\_gcp](na_cloudmanager_cvo_gcp_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-cvo-gcp-module) – NetApp Cloud Manager CVO for GCP * [na\_cloudmanager\_info](na_cloudmanager_info_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-info-module) – NetApp Cloud Manager info * [na\_cloudmanager\_nss\_account](na_cloudmanager_nss_account_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-nss-account-module) – NetApp Cloud Manager nss account * [na\_cloudmanager\_snapmirror](na_cloudmanager_snapmirror_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-snapmirror-module) – NetApp Cloud Manager SnapMirror * [na\_cloudmanager\_volume](na_cloudmanager_volume_module#ansible-collections-netapp-cloudmanager-na-cloudmanager-volume-module) – NetApp Cloud Manager volume See also List of [collections](../../index#list-of-collections) with docs hosted here. ansible netapp.cloudmanager.na_cloudmanager_connector_aws – NetApp Cloud Manager connector for AWS netapp.cloudmanager.na\_cloudmanager\_connector\_aws – NetApp Cloud Manager connector for AWS ============================================================================================= Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_connector_aws`. New in version 21.3.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create or delete Cloud Manager connector for AWS. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_id string \| \| The NetApp tenancy account ID. \| \| ami string \| \| The image ID. \| \| associate\_public\_ip\_address boolean \| Choices:* no * yes ← \| Indicates whether to associate a public IP address to the instance. If not provided, the association will be done based on the subnet's configuration. \| \| aws\_tag list / elements=dictionary \| \| Additional tags for the AWS EC2 instance. \| \| \| tag\_key string \| \| The key of the tag. \| \| \| tag\_value string \| \| The tag value. \| \| client\_id string \| \| The unique client ID of the Connector. \| \| company string \| \| The name of the company of the user. \| \| enable\_termination\_protection boolean \| Choices:* no ← * yes \| Indicates whether to enable termination protection on the instance. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| iam\_instance\_profile\_name string \| \| The name of the instance profile for the Connector. \| \| instance\_id string \| \| The ID of the EC2 instance used for delete. \| \| instance\_type string \| Default:"t3.xlarge" \| The type of instance (for example, t3.xlarge). At least 4 CPU and 16 GB of memory are required. \| \| key\_name string \| \| The name of the key pair to use for the Connector instance. \| \| name string / required \| \| The name of the Cloud Manager connector for AWS to manage. \| \| proxy\_certificates list / elements=string added in 21.5.0 of netapp.cloudmanager \| \| The proxy certificates, a list of certificate file names. \| \| proxy\_password string \| \| The proxy password, if using a proxy to connect to the internet. \| \| proxy\_url string \| \| The proxy URL, if using a proxy to connect to the internet. \| \| proxy\_user\_name string \| \| The proxy user name, if using a proxy to connect to the internet. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| region string / required \| \| The region where the Cloud Manager Connector will be created. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| security\_group\_ids list / elements=string \| \| The IDs of the security groups for the instance, multiple security groups can be provided separated by ','. \| \| state string \| Choices:* present ← * absent \| Whether the specified Cloud Manager connector for AWS should exist or not. \| \| subnet\_id string \| \| The ID of the subnet for the instance. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create NetApp Cloud Manager connector for AWS netapp.cloudmanager.na_cloudmanager_connector_aws: state: present refresh_token: "{{ xxxxxxxxxxxxxxx }}" name: bsuhas_ansible_occm region: us-west-1 key_name: dev_automation subnet_id: subnet-xxxxx security_group_ids: [sg-xxxxxxxxxxx] iam_instance_profile_name: OCCM_AUTOMATION account_id: "{{ account-xxxxxxx }}" company: NetApp proxy_url: abc.com proxy_user_name: xyz proxy_password: abcxyz proxy_certificates: [abc.crt.txt, xyz.crt.txt] aws_tag: [ {tag_key: abc, tag_value: a123}] - name: Delete NetApp Cloud Manager connector for AWS netapp.cloudmanager.na_cloudmanager_connector_aws: state: absent name: ansible region: us-west-1 account_id: "{{ account-xxxxxxx }}" instance_id: i-xxxxxxxxxxxxx client_id: xxxxxxxxxxxxxxxxxxx ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| ids dictionary \| success \| Newly created AWS client ID in cloud manager, instance ID and account ID. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#254b4208444b564c47494051404448030616121e030610171e0306111d1e4b4051445555030611131e464a48)> ansible netapp.cloudmanager.na_cloudmanager_info – NetApp Cloud Manager info netapp.cloudmanager.na\_cloudmanager\_info – NetApp Cloud Manager info ====================================================================== Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_info`. New in version 21.4.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * This module allows you to gather various information about cloudmanager using REST APIs. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| gather\_subsets list / elements=string \| Default:"all" \| When supplied, this argument will restrict the information collected to a given subset. Possible values for this argument include working\_environments\_info aggregates\_info accounts\_info \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| Notes ----- Note * Support check\_mode * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Get all available subsets netapp.cloudmanager.na_cloudmanager_info: client_id: "{{ client_id }}" refresh_token: "{{ refresh_token }}" gather_subsets: - all - name: Collect data for cloud manager with indicated subsets netapp.cloudmanager.na_cloudmanager_info: client_id: "{{ client_id }}" refresh_token: "{{ refresh_token }}" gather_subsets: - aggregates_info - working_environments_info ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| info dictionary \| success \| a dictionary of collected subsets each subset if in JSON format Sample: { "info": { "working\_environments\_info": [ { "azureVsaWorkingEnvironments": [], "gcpVsaWorkingEnvironments": [], "onPremWorkingEnvironments": [], "vsaWorkingEnvironments": [ { "actionsRequired": null, "activeActions": null, "awsProperties": null, "capacityFeatures": null, "cbsProperties": null, "cloudProviderName": "Amazon", "cloudSyncProperties": null, "clusterProperties": null, "complianceProperties": null, "creatorUserEmail": "samlp\|NetAppSAML\|test\_user", "cronJobSchedules": null, "encryptionProperties": null, "fpolicyProperties": null, "haProperties": null, "interClusterLifs": null, "isHA": false, "k8sProperties": null, "monitoringProperties": null, "name": "testAWS", "ontapClusterProperties": null, "publicId": "VsaWorkingEnvironment-3txYJOsX", "replicationProperties": null, "reservedSize": null, "saasProperties": null, "schedules": null, "snapshotPolicies": null, "status": null, "supportRegistrationInformation": [], "supportRegistrationProperties": null, "supportedFeatures": null, "svmName": "svm\_testAWS", "svms": null, "tenantId": "Tenant-2345", "workingEnvironmentType": "VSA" } ] }, null ] } } \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#abc5cc86cac5d8c2c9c7cedfcecac68d88989c908d889e99908d889f9390c5cedfcadbdb8d889f9d90c8c4c6)>	programming_docs
ansible netapp.cloudmanager.na_cloudmanager_cvo_aws – NetApp Cloud Manager CVO for AWS netapp.cloudmanager.na\_cloudmanager\_cvo\_aws – NetApp Cloud Manager CVO for AWS ================================================================================= Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_cvo_aws`. New in version 21.3.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, delete, or manage Cloud Manager CVO for AWS. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| aws\_tag list / elements=dictionary \| \| Additional tags for the AWS CVO working environment. \| \| \| tag\_key string \| \| The key of the tag. \| \| \| tag\_value string \| \| The tag value. \| \| backup\_volumes\_to\_cbs boolean \| Choices:* no ← * yes \| Automatically enable back up of all volumes to S3. \| \| capacity\_package\_name string added in 21.12.0 of netapp.cloudmanager \| Choices:* Professional * Essential * Freemium \| Capacity package name is required when selecting a capacity based license. Essential only available with Bring Your Own License Capacity-Based. Professional available as an annual contract from AWS marketplace or Bring Your Own License Capacity-Based. \| \| capacity\_tier string \| Choices:* S3 ← * NONE \| Whether to enable data tiering for the first data aggregate. \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. You can find the ID from the Connector tab on <https://cloudmanager.netapp.com>. \| \| cloud\_provider\_account string \| \| The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector. \| \| cluster\_floating\_ip string \| \| For HA FloatingIP, the cluster management floating IP address. \| \| data\_encryption\_type string \| Choices:* AWS ← * NONE \| The type of encryption to use for the working environment. \| \| data\_floating\_ip string \| \| For HA FloatingIP, the data floating IP address. \| \| data\_floating\_ip2 string \| \| For HA FloatingIP, the data floating IP address. \| \| ebs\_volume\_size integer \| Default:1 \| EBS volume size for the first data aggregate. For GB, the value can be [100 or 500]. For TB, the value can be [1,2,4,8,16]. \| \| ebs\_volume\_size\_unit string \| Choices:* GB * TB ← \| The unit for ebs volume size. \| \| ebs\_volume\_type string \| Choices:* gp3 * gp2 ← * io1 * sc1 * st1 \| The EBS volume type for the first data aggregate. \| \| enable\_compliance boolean \| Choices:* no ← * yes \| Enable the Cloud Compliance service on the working environment. \| \| enable\_monitoring boolean \| Choices:* no ← * yes \| Enable the Monitoring service on the working environment. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| failover\_mode string \| Choices:* PrivateIP * FloatingIP \| For HA, the failover mode for the HA pair. 'PrivateIP' is for a single availability zone and 'FloatingIP' is for multiple availability zones. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| instance\_profile\_name string \| \| The instance profile name for the working environment. If not provided, Cloud Manager creates the instance profile. \| \| instance\_tenancy string \| Choices:* default ← * dedicated \| The EC2 instance tenancy. \| \| instance\_type string \| Default:"m5.2xlarge" \| The instance type to use, which depends on the license type. Explore ['m5.xlarge']. Standard ['m5.2xlarge','r5.xlarge']. Premium ['m5.4xlarge','r5.2xlarge','c4.8xlarge']. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. \| \| iops integer \| \| Provisioned IOPS. Required only when provider\_volume\_type is 'io1' or 'gp3'. \| \| is\_ha boolean \| Choices:* no ← * yes \| Indicate whether the working environment is an HA pair or not. \| \| kms\_key\_arn string added in 21.10.0 of netapp.cloudmanager \| \| AWS encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified. \| \| kms\_key\_id string \| \| Aws Encryption parameters. It is required if using aws encryption. Only one of KMS key id or KMS arn should be specified. \| \| license\_type string \| Choices:* cot-standard-paygo ← * cot-premium-paygo * cot-explore-paygo * cot-premium-byol * ha-cot-standard-paygo * ha-cot-premium-paygo * ha-cot-premium-byol * ha-cot-explore-paygo * capacity-paygo * ha-capacity-paygo \| The type of license to use. For single node ['cot-explore-paygo','cot-standard-paygo', 'cot-premium-paygo', 'cot-premium-byol', 'capacity-paygo']. For HA ['ha-cot-explore-paygo','ha-cot-standard-paygo','ha-cot-premium-paygo','ha-cot-premium-byol', 'ha-capacity-paygo']. Use capacity-paygo or ha-capacity-paygo for HA on selecting Bring Your Own License type Capacity-Based or Freemium. Use cot-premium-boyl or ha-cot-permium-boyl for HA on selecting Bring Your Own License type Node-Based. \| \| mediator\_assign\_public\_ip boolean \| Choices:* no * yes ← \| Boolean option to assign public IP. \| \| mediator\_key\_pair\_name string \| \| For HA, the key pair name for the mediator instance. \| \| mediator\_subnet\_id string \| \| For HA, the subnet ID of the mediator. \| \| name string / required \| \| The name of the Cloud Manager CVO for AWS to manage. \| \| node1\_subnet\_id string \| \| For HA, the subnet ID of the first node. \| \| node2\_subnet\_id string \| \| For HA, the subnet ID of the second node. \| \| nss\_account string \| \| The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account is not provided, Cloud Manager tries to use the first existing NSS account. \| \| ontap\_version string \| Default:"latest" \| The required ONTAP version. Ignored if 'use\_latest\_version' is set to true. \| \| optimized\_network\_utilization boolean \| Choices:* no * yes ← \| Use optimized network utilization. \| \| platform\_serial\_number string \| \| The serial number for the cluster. This is required when using 'cot-premium-byol'. \| \| platform\_serial\_number\_node1 string \| \| For HA BYOL, the serial number for the first node. This is required when using 'ha-cot-premium-byol'. \| \| platform\_serial\_number\_node2 string \| \| For HA BYOL, the serial number for the second node. This is required when using 'ha-cot-premium-byol'. \| \| provided\_license string \| \| Using a NLF license file for BYOL deployment. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| region string / required \| \| The region where the working environment will be created. \| \| route\_table\_ids list / elements=string \| \| For HA FloatingIP, the list of route table IDs that will be updated with the floating IPs. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| security\_group\_id string \| \| The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group. \| \| state string \| Choices:* present ← * absent \| Whether the specified Cloud Manager CVO for AWS should exist or not. \| \| subnet\_id string \| \| The subnet id where the working environment will be created. Required when single node only. \| \| svm\_floating\_ip string \| \| For HA FloatingIP, the SVM management floating IP address. \| \| svm\_password string / required \| \| The admin password for Cloud Volumes ONTAP. It will be updated on each run. \| \| throughput integer \| \| Unit is Mb/s. Valid range 125-1000. Required only when provider\_volume\_type is 'gp3'. \| \| tier\_level string \| Choices:* normal ← * ia * ia-single * intelligent \| The tiering level when 'capacity\_tier' is set to 'S3'. \| \| use\_latest\_version boolean \| Choices:* no * yes ← \| Indicates whether to use the latest available ONTAP version. \| \| vpc\_id string \| \| The VPC ID where the working environment will be created. If this argument is not provided, the VPC will be calculated by using the provided subnet ID. \| \| workspace\_id string \| \| The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on <https://cloudmanager.netapp.com>. \| \| writing\_speed\_state string \| \| The write speed setting for Cloud Volumes ONTAP ['NORMAL','HIGH']. This argument is not relevant for HA pairs. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create NetApp Cloud Manager CVO for AWS single netapp.cloudmanager.na_cloudmanager_cvo_aws: state: present refresh_token: "{{ xxxxxxxxxxxxxxx }}" name: AnsibleCVO region: us-west-1 subnet_id: subnet-xxxxxxx vpc_id: vpc-xxxxxxxx svm_password: P@assword! client_id: "{{ xxxxxxxxxxxxxxx }}" writing_speed_state: NORMAL aws_tag: [ {tag_key: abc, tag_value: a123}] - name: Create NetApp Cloud Manager CVO for AWS HA netapp.cloudmanager.na_cloudmanager_cvo_aws: state: present refresh_token: "{{ xxxxxxxxxxxxxxx }}" name: AnsibleCVO region: us-west-1 subnet_id: subnet-xxxxxxx vpc_id: vpc-xxxxxxxx svm_password: P@assword! client_id: "{{ xxxxxxxxxxxxxxx }}" writing_speed_state: NORMAL aws_tag: [ {tag_key: abc, tag_value: a123}] is_ha: true failover_mode: FloatingIP node1_subnet_id: subnet-1 node2_subnet_id: subnet-1 mediator_subnet_id: subnet-1 mediator_key_pair_name: key1 cluster_floating_ip: 2.1.1.1 data_floating_ip: 2.1.1.2 data_floating_ip2: 2.1.1.3 svm_floating_ip: 2.1.1.4 route_table_ids: [rt-1,rt-2] - name: Delete NetApp Cloud Manager cvo for AWS netapp.cloudmanager.na_cloudmanager_cvo_aws: state: absent name: ansible region: us-west-1 refresh_token: "{{ xxxxxxxxxxxxxxx }}" subnet_id: subnet-xxxxxxx vpc_id: vpc-xxxxxxxx svm_password: P@assword! client_id: "{{ xxxxxxxxxxxxxxx }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| working\_environment\_id string \| success \| Newly created AWS CVO working\_environment\_id. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#2d434a004c435e444f414859484c400b0e1e1a160b0e181f160b0e1915164348594c5d5d0b0e191b164e4240)> ansible netapp.cloudmanager.na_cloudmanager_cvo_gcp – NetApp Cloud Manager CVO for GCP netapp.cloudmanager.na\_cloudmanager\_cvo\_gcp – NetApp Cloud Manager CVO for GCP ================================================================================= Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_cvo_gcp`. New in version 21.4.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, delete, or manage Cloud Manager CVO for GCP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| backup\_volumes\_to\_cbs boolean \| Choices:* no ← * yes \| Automatically backup all volumes to cloud. \| \| capacity\_package\_name string added in 21.12.0 of netapp.cloudmanager \| Choices:* Professional * Essential * Freemium \| Capacity package name is required when selecting a capacity based license. Essential only available with Bring Your Own License Capacity-Based. Professional available as an annual contract from a cloud provider or Bring Your Own License Capacity-Based. \| \| capacity\_tier string \| Choices:* cloudStorage \| Whether to enable data tiering for the first data aggregate. \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. You can find the ID from the Connector tab on <https://cloudmanager.netapp.com>. \| \| data\_encryption\_type string \| Choices:* GCP \| Type of encryption to use for this working environment. \| \| enable\_compliance boolean \| Choices:* no ← * yes \| Enable the Cloud Compliance service on the working environment. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| firewall\_rule string \| \| Firewall name for a single node cluster. \| \| gcp\_encryption\_parameters string added in 21.10.0 of netapp.cloudmanager \| \| The GCP encryption parameters. \| \| gcp\_labels list / elements=dictionary \| \| Optionally provide up to four key-value pairs with which to all GCP entities created by Cloud Manager. \| \| \| label\_key string \| \| The key of the label. \| \| \| label\_value string \| \| The label value. \| \| gcp\_service\_account string / required \| \| The gcp\_service\_account email in order to enable tiering of cold data to Google Cloud Storage. \| \| gcp\_volume\_size integer \| \| GCP volume size. \| \| gcp\_volume\_size\_unit string \| Choices:* GB * TB \| GCP volume size unit. \| \| gcp\_volume\_type string \| Choices:* pd-balanced * pd-standard * pd-ssd \| GCP volume type. \| \| instance\_type string \| Default:"n1-standard-8" \| The type of instance to use, which depends on the license type you choose. Explore ['custom-4-16384']. Standard ['n1-standard-8']. Premium ['n1-standard-32']. BYOL all instance types defined for PayGo. For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. \| \| is\_ha boolean \| Choices:* no ← * yes \| Indicate whether the working environment is an HA pair or not. \| \| license\_type string \| Choices:* gcp-cot-standard-paygo ← * gcp-cot-explore-paygo * gcp-cot-premium-paygo * gcp-cot-premium-byol * gcp-ha-cot-standard-paygo * gcp-ha-cot-premium-paygo * gcp-ha-cot-explore-paygo * gcp-ha-cot-premium-byol * capacity-paygo * ha-capacity-paygo \| The type of license to use. Single node ['gcp-cot-explore-paygo', 'gcp-cot-standard-paygo', 'gcp-cot-premium-paygo', 'gcp-cot-premium-byol', 'capacity-paygo']. HA ['gcp-ha-cot-explore-paygo', 'gcp-ha-cot-standard-paygo', 'gcp-ha-cot-premium-paygo', 'gcp-cot-premium-byol', 'ha-capacity-paygo']. Use capacity-paygo or ha-capacity-paygo for HA on selecting Bring Your Own License type Capacity-Based or Freemium. Use gcp-cot-premium-boyl or gcp-ha-cot-permium-boyl for HA on selecting Bring Your Own License type Node-Based. \| \| mediator\_zone string \| \| The zone for mediator. Option for HA pair only. \| \| name string / required \| \| The name of the Cloud Manager CVO for GCP to manage. \| \| network\_project\_id string \| \| The project id in GCP associated with the Subnet. If not provided, it is assumed that the Subnet is within the previously specified project id. \| \| node1\_zone string \| \| Zone for node 1. Option for HA pair only. \| \| node2\_zone string \| \| Zone for node 2. Option for HA pair only. \| \| nss\_account string \| \| The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account. \| \| ontap\_version string \| Default:"latest" \| The required ONTAP version. Ignored if 'use\_latest\_version' is set to true. \| \| platform\_serial\_number string \| \| The serial number for the system. Required when using 'gcp-cot-premium-byol'. \| \| platform\_serial\_number\_node1 string \| \| For HA BYOL, the serial number for the first node. Option for HA pair only. \| \| platform\_serial\_number\_node2 string \| \| For HA BYOL, the serial number for the second node. Option for HA pair only. \| \| project\_id string / required \| \| The ID of the GCP project. \| \| provided\_license string \| \| Using a NLF license file for BYOL deployment \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| state string \| Choices:* present ← * absent \| Whether the specified Cloud Manager CVO for GCP should exist or not. \| \| subnet0\_node\_and\_data\_connectivity string \| \| Subnet path for nic1, required for node and data connectivity. If using shared VPC, network\_project\_id must be provided. Option for HA pair only. \| \| subnet1\_cluster\_connectivity string \| \| Subnet path for nic2, required for cluster connectivity. Option for HA pair only. \| \| subnet2\_ha\_connectivity string \| \| Subnet path for nic3, required for HA connectivity. Option for HA pair only. \| \| subnet3\_data\_replication string \| \| Subnet path for nic4, required for HA connectivity. Option for HA pair only. \| \| subnet\_id string \| \| The name of the subnet for Cloud Volumes ONTAP. \| \| svm\_password string \| \| The admin password for Cloud Volumes ONTAP. It will be updated on each run. \| \| tier\_level string \| Choices:* standard ← * nearline * coldline \| The tiering level when 'capacity\_tier' is set to 'cloudStorage'. \| \| use\_latest\_version boolean \| Choices:* no * yes ← \| Indicates whether to use the latest available ONTAP version. \| \| vpc0\_firewall\_rule\_name string \| \| Firewall rule name for vpc1. Option for HA pair only. \| \| vpc0\_node\_and\_data\_connectivity string \| \| VPC path for nic1, required for node and data connectivity. If using shared VPC, network\_project\_id must be provided. Option for HA pair only. \| \| vpc1\_cluster\_connectivity string \| \| VPC path for nic2, required for cluster connectivity. Option for HA pair only. \| \| vpc1\_firewall\_rule\_name string \| \| Firewall rule name for vpc2. Option for HA pair only. \| \| vpc2\_firewall\_rule\_name string \| \| Firewall rule name for vpc3. Option for HA pair only. \| \| vpc2\_ha\_connectivity string \| \| VPC path for nic3, required for HA connectivity. Option for HA pair only. \| \| vpc3\_data\_replication string \| \| VPC path for nic4, required for data replication. Option for HA pair only. \| \| vpc3\_firewall\_rule\_name string \| \| Firewall rule name for vpc4. Option for HA pair only. \| \| vpc\_id string / required \| \| The name of the VPC. \| \| workspace\_id string \| \| The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on [https://cloudmanager.netapp.com]. \| \| writing\_speed\_state string \| Default:"NORMAL" \| The write speed setting for Cloud Volumes ONTAP ['NORMAL','HIGH']. This argument is not relevant for HA pairs. \| \| zone string / required \| \| The zone of the region where the working environment will be created. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create NetApp Cloud Manager cvo for GCP netapp.cloudmanager.na_cloudmanager_cvo_gcp: state: present name: ansiblecvogcp project_id: default-project zone: us-east4-b subnet_id: default gcp_volume_type: pd-ssd gcp_volume_size: 500 gcp_volume_size_unit: GB gcp_service_account: "{{ xxxxxxxxxxxxxxx }}" data_encryption_type: GCP svm_password: "{{ xxxxxxxxxxxxxxx }}" ontap_version: latest use_latest_version: true license_type: gcp-cot-standard-paygo instance_type: n1-standard-8 client_id: "{{ xxxxxxxxxxxxxxx }}" workspace_id: "{{ xxxxxxxxxxxxxxx }}" capacity_tier: cloudStorage writing_speed_state: NORMAL refresh_token: "{{ xxxxxxxxxxxxxxx }}" vpc_id: default gcp_labels: - label_key: key1 label_value: value1 - label_key: key2 label_value: value2 - name: Create NetApp Cloud Manager cvo ha for GCP netapp.cloudmanager.na_cloudmanager_cvo_gcp: state: present name: ansiblecvogcpha project_id: "default-project" zone: us-east1-b gcp_volume_type: pd-ssd gcp_volume_size: 500 gcp_volume_size_unit: GB gcp_service_account: "{{ xxxxxxxxxxxxxxx }}" data_encryption_type: GCP svm_password: "{{ xxxxxxxxxxxxxxx }}" ontap_version: ONTAP-9.9.0.T1.gcpha use_latest_version: false license_type: gcp-ha-cot-explore-paygo instance_type: custom-4-16384 client_id: "{{ xxxxxxxxxxxxxxx }}" workspace_id: "{{ xxxxxxxxxxxxxxx }}" capacity_tier: cloudStorage writing_speed_state: NORMAL refresh_token: "{{ xxxxxxxxxxxxxxx }}" is_ha: true mediator_zone: us-east1-b node1_zone: us-east1-b node2_zone: us-east1-b subnet0_node_and_data_connectivity: default subnet1_cluster_connectivity: subnet2 subnet2_ha_connectivity: subnet3 subnet3_data_replication: subnet1 vpc0_node_and_data_connectivity: default vpc1_cluster_connectivity: vpc2 vpc2_ha_connectivity: vpc3 vpc3_data_replication: vpc1 vpc_id: default subnet_id: default ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| working\_environment\_id string \| success \| Newly created GCP CVO working\_environment\_id. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#1f7178327e716c767d737a6b7a7e72393c2c2824393c2a2d24393c2b2724717a6b7e6f6f393c2b29247c7072)>	programming_docs
ansible netapp.cloudmanager.na_cloudmanager_cvo_azure – NetApp Cloud Manager CVO/working environment in single or HA mode for Azure. netapp.cloudmanager.na\_cloudmanager\_cvo\_azure – NetApp Cloud Manager CVO/working environment in single or HA mode for Azure. =============================================================================================================================== Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_cvo_azure`. New in version 21.4.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, delete, or manage Cloud Manager CVO/working environment in single or HA mode for Azure. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| allow\_deploy\_in\_existing\_rg boolean \| Choices:* no ← * yes \| Indicates if to allow creation in existing resource group \| \| azure\_encryption\_parameters string added in 21.10.0 of netapp.cloudmanager \| \| AZURE encryption parameters. It is required if using AZURE encryption. \| \| azure\_tag list / elements=dictionary \| \| Additional tags for the AZURE CVO working environment. \| \| \| tag\_key string \| \| The key of the tag. \| \| \| tag\_value string \| \| The tag value. \| \| backup\_volumes\_to\_cbs boolean \| Choices:* no ← * yes \| Automatically enable back up of all volumes to S3. \| \| capacity\_package\_name string added in 21.12.0 of netapp.cloudmanager \| Choices:* Professional * Essential * Freemium \| Capacity package name is required when selecting a capacity based license. Essential only available with Bring Your Own License Capacity-Based. Professional available as an annual contract from a cloud provider or Bring Your Own License Capacity-Based. \| \| capacity\_tier string \| Choices:* Blob ← * NONE \| Whether to enable data tiering for the first data aggregate \| \| cidr string / required \| \| The CIDR of the VNET. \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. You can find the ID from the Connector tab on [https://cloudmanager.netapp.com]. \| \| cloud\_provider\_account string \| \| The cloud provider credentials id to use when deploying the Cloud Volumes ONTAP system. You can find the ID in Cloud Manager from the Settings > Credentials page. If not specified, Cloud Manager uses the instance profile of the Connector. \| \| data\_encryption\_type string \| Choices:* AZURE ← * NONE \| The type of encryption to use for the working environment. \| \| disk\_size integer \| Default:1 \| Azure volume size for the first data aggregate. For GB, the value can be [100, 500]. For TB, the value can be [1,2,4,8,16]. \| \| disk\_size\_unit string \| Choices:* GB * TB ← \| The unit for disk size. \| \| enable\_compliance boolean \| Choices:* no ← * yes \| Enable the Cloud Compliance service on the working environment. \| \| enable\_monitoring boolean \| Choices:* no ← * yes \| Enable the Monitoring service on the working environment. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| ha\_enable\_https boolean added in 21.10.0 of netapp.cloudmanager \| Choices:* no * yes \| For HA, enable the HTTPS connection from CVO to storage accounts. This can impact write performance. The default is false. \| \| instance\_type string \| Default:"Standard\_DS4\_v2" \| The type of instance to use, which depends on the license type you chose. Explore ['Standard\_DS3\_v2'] Standard ['Standard\_DS4\_v2, Standard\_DS13\_v2,Standard\_L8s\_v2'] Premium ['Standard\_DS5\_v2', 'Standard\_DS14\_v2'] For more supported instance types, refer to Cloud Volumes ONTAP Release Notes. \| \| is\_ha boolean \| Choices:* no ← * yes \| Indicate whether the working environment is an HA pair or not. \| \| license\_type string \| Choices:* azure-cot-standard-paygo ← * azure-cot-premium-paygo * azure-cot-premium-byol * azure-cot-explore-paygo * azure-ha-cot-standard-paygo * azure-ha-cot-premium-paygo * azure-ha-cot-premium-byol * capacity-paygo * ha-capacity-paygo \| The type of license to use. For single node ['azure-cot-explore-paygo', 'azure-cot-standard-paygo', 'azure-cot-premium-paygo', 'azure-cot-premium-byol', 'capacity-paygo'] For HA ['azure-ha-cot-standard-paygo', 'azure-ha-cot-premium-paygo', 'azure-ha-cot-premium-byol', 'ha-capacity-paygo'] Use capacity-paygo or ha-capacity-paygo for HA on selecting Bring Your Own License type Capacity-Based or Freemium. Use azure-cot-premium-boyl or azure-ha-cot-permium-boyl for HA on selecting Bring Your Own License type Node-Based. \| \| location string / required \| \| The location where the working environment will be created. \| \| name string / required \| \| The name of the Cloud Manager CVO for AZURE to manage. \| \| nss\_account string \| \| The NetApp Support Site account ID to use with this Cloud Volumes ONTAP system. If the license type is BYOL and an NSS account isn't provided, Cloud Manager tries to use the first existing NSS account. \| \| ontap\_version string \| Default:"latest" \| The required ONTAP version. Ignored if 'use\_latest\_version' is set to true \| \| platform\_serial\_number\_node1 string \| \| For HA BYOL, the serial number for the first node. \| \| platform\_serial\_number\_node2 string \| \| For HA BYOL, the serial number for the second node. \| \| provided\_license string \| \| Using a NLF license file for BYOL deployment. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| resource\_group string \| \| The resource\_group where Cloud Volumes ONTAP will be created. If not provided, Cloud Manager generates the resource group name (name of the working environment/CVO with suffix '-rg'). If the resource group does not exist, it is created. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| security\_group\_id string \| \| The ID of the security group for the working environment. If not provided, Cloud Manager creates the security group. \| \| serial\_number string \| \| The serial number for the cluster Required when using one of these, 'azure-cot-premium-byol' or 'azure-ha-cot-premium-byol' \| \| state string \| Choices:* present ← * absent \| Whether the specified Cloud Manager CVO for AZURE should exist or not. \| \| storage\_type string \| Choices:* Premium\_LRS ← * Standard\_LRS * StandardSSD\_LRS \| The type of storage for the first data aggregate. \| \| subnet\_id string / required \| \| The name of the subnet for the Cloud Volumes ONTAP system. \| \| subscription\_id string / required \| \| The ID of the Azure subscription. \| \| svm\_password string / required \| \| The admin password for Cloud Volumes ONTAP. It will be updated on each run. \| \| tier\_level string \| Choices:* normal ← * cool \| If capacity\_tier is Blob, this argument indicates the tiering level. \| \| use\_latest\_version boolean \| Choices:* no * yes ← \| Indicates whether to use the latest available ONTAP version. \| \| vnet\_id string / required \| \| The name of the virtual network. \| \| vnet\_resource\_group string \| \| The resource group in Azure associated to the virtual network. \| \| workspace\_id string \| \| The ID of the Cloud Manager workspace where you want to deploy Cloud Volumes ONTAP. If not provided, Cloud Manager uses the first workspace. You can find the ID from the Workspace tab on [https://cloudmanager.netapp.com]. \| \| writing\_speed\_state string \| \| The write speed setting for Cloud Volumes ONTAP ['NORMAL','HIGH']. This argument is not relevant for HA pairs. \| Notes ----- Note * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: create NetApp Cloud Manager CVO for Azure single netapp.cloudmanager.na_cloudmanager_cvo_azure: state: present refresh_token: "{{ xxxxxxxxxxxxxxx }}" name: AnsibleCVO location: westus subnet_id: subnet-xxxxxxx vnet_id: vnetxxxxxxxx svm_password: P@assword! client_id: "{{ xxxxxxxxxxxxxxx }}" writing_speed_state: NORMAL azure_tag: [ {tag_key: abc, tag_value: a123}] - name: create NetApp Cloud Manager CVO for Azure HA netapp.cloudmanager.na_cloudmanager_cvo_azure: state: present refresh_token: "{{ xxxxxxxxxxxxxxx }}" name: AnsibleCVO location: westus subnet_id: subnet-xxxxxxx vnet_id: vnetxxxxxxxx svm_password: P@assword! client_id: "{{ xxxxxxxxxxxxxxx }}" writing_speed_state: NORMAL azure_tag: [ {tag_key: abc, tag_value: a123}] is_ha: true - name: delete NetApp Cloud Manager cvo for Azure netapp.cloudmanager.na_cloudmanager_cvo_azure: state: absent name: ansible refresh_token: "{{ xxxxxxxxxxxxxxx }}" location: westus subnet_id: subnet-xxxxxxx vnet_id: vnetxxxxxxxx svm_password: P@assword! client_id: "{{ xxxxxxxxxxxxxxx }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| working\_environment\_id string \| success \| Newly created AZURE CVO working\_environment\_id. \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f59b92d8949b869c97999081909498d3d6c6c2ced3d6c0c7ced3d6c1cdce9b9081948585d3d6c1c3ce969a98)> ansible netapp.cloudmanager.na_cloudmanager_cifs_server – NetApp Cloud Manager cifs server netapp.cloudmanager.na\_cloudmanager\_cifs\_server – NetApp Cloud Manager cifs server ===================================================================================== Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_cifs_server`. New in version 21.3.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or Delete a CIFS server on the Cloud Volume ONTAP system to support CIFS volumes, based on an Active Directory or Workgroup. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. \| \| dns\_domain string \| \| The DNS domain name. For CIFS AD only. \| \| domain string \| \| The active directory domain name. For CIFS AD only. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| ip\_addresses list / elements=string \| \| The DNS server IP addresses. For CIFS AD only. \| \| is\_workgroup boolean \| Choices:* no * yes \| For CIFS workgroup operations, set to true. \| \| netbios string \| \| The CIFS server NetBIOS name. For CIFS AD only. \| \| organizational\_unit string \| \| The organizational unit in which to register the CIFS server. For CIFS AD only. \| \| password string \| \| The active directory admin password. For CIFS AD only. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| server\_name string \| \| The server name. For CIFS workgroup only. \| \| state string \| Choices:* present ← * absent \| Whether the specified cifs server should exist or not. \| \| username string \| \| The active directory admin user name. For CIFS AD only. \| \| workgroup\_name string \| \| The workgroup name. For CIFS workgroup only. \| \| working\_environment\_id string \| \| The public ID of the working environment where the cifs server will be created. \| \| working\_environment\_name string \| \| The working environment name where the cifs server will be created. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create cifs server with working_environment_id netapp.cloudmanager.na_cloudmanager_cifs_server: state: present working_environment_id: VsaWorkingEnvironment-abcdefgh client_id: your_client_id refresh_token: your_refresh_token domain: example.com username: admin password: pass dns_domain: example.com ip_addresses: ["1.0.0.0"] netbios: cvoname organizational_unit: CN=Computers ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b0ded79dd1dec3d9d2dcd5c4d5d1dd969383878b969385828b969384888bded5c4d1c0c0969384868bd3dfdd)> ansible netapp.cloudmanager.na_cloudmanager_snapmirror – NetApp Cloud Manager SnapMirror netapp.cloudmanager.na\_cloudmanager\_snapmirror – NetApp Cloud Manager SnapMirror ================================================================================== Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_snapmirror`. New in version 21.6.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) Synopsis -------- * Create or Delete SnapMirror relationship on Cloud Manager. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| capacity\_tier string \| Choices:* S3 * Blob * cloudStorage * NONE \| The volume capacity tier for tiering cold data to object storage. The default values for each cloud provider are as follows, Amazon 'S3', Azure 'Blob', GCP 'cloudStorage'. If NONE, the capacity tier will not be set on volume creation. \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. \| \| destination\_aggregate\_name string \| \| The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you. \| \| destination\_svm\_name string \| \| The name of the destination SVM. The default SVM name is used, if a name is not provided. \| \| destination\_volume\_name string / required \| \| The name of the destination volume to be created for snapmirror relationship. \| \| destination\_working\_environment\_id string \| \| The public ID of the working environment of the destination volume. \| \| destination\_working\_environment\_name string \| \| The working environment name of the destination volume. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| max\_transfer\_rate integer \| Default:100000 \| Maximum transfer rate limit KB/s. Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. \| \| policy string \| Default:"MirrorAllSnapshots" \| The SnapMirror policy name. \| \| provider\_volume\_type string \| \| The underlying cloud provider volume type. For AWS ['gp3', 'gp2', 'io1', 'st1', 'sc1']. For Azure ['Premium\_LRS','Standard\_LRS','StandardSSD\_LRS']. For GCP ['pd-balanced','pd-ssd','pd-standard']. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| schedule string \| Default:"1hour" \| The name of the Schedule. \| \| source\_svm\_name string \| \| The name of the source SVM. The default SVM name is used, if a name is not provided. \| \| source\_volume\_name string / required \| \| The name of the source volume. \| \| source\_working\_environment\_id string \| \| The public ID of the working environment of the source volume. \| \| source\_working\_environment\_name string \| \| The working environment name of the source volume. \| \| state string \| Choices:* present ← * absent \| Whether the specified snapmirror relationship should exist or not. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create snapmirror with working_environment_name netapp.cloudmanager.na_cloudmanager_snapmirror: state: present source_working_environment_name: source destination_working_environment_name: dest source_volume_name: source destination_volume_name: source_copy policy: MirrorAllSnapshots schedule: 5min max_transfer_rate: 102400 client_id: client_id refresh_token: refresh_token - name: Delete snapmirror netapp.cloudmanager.na_cloudmanager_snapmirror: state: absent source_working_environment_name: source destination_working_environment_name: dest source_volume_name: source destination_volume_name: source_copy client_id: client_id refresh_token: refresh_token ``` ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#c1afa6eca0afb2a8a3ada4b5a4a0ace7e2f2f6fae7e2f4f3fae7e2f5f9faafa4b5a0b1b1e7e2f5f7faa2aeac)>	programming_docs
ansible netapp.cloudmanager.na_cloudmanager_aggregate – NetApp Cloud Manager Aggregate netapp.cloudmanager.na\_cloudmanager\_aggregate – NetApp Cloud Manager Aggregate ================================================================================ Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_aggregate`. New in version 21.3.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create, Modify or Delete Aggregate on Cloud Manager. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| capacity\_tier string \| Choices:* NONE * S3 * Blob * cloudStorage \| The aggregate's capacity tier for tiering cold data to object storage. If the value is NONE, the capacity\_tier will not be set on aggregate creation. \| \| client\_id string / required \| \| The client ID of the Cloud Manager Connector. \| \| disk\_size\_size integer \| \| The required size of the disks. \| \| disk\_size\_unit string \| Choices:* GB * TB ← \| The disk size unit ['GB' or 'TB']. The default is 'TB'. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| home\_node string \| \| The home node that the new aggregate should belong to. \| \| iops integer \| \| Provisioned IOPS. Needed only when providerVolumeType is "io1". \| \| name string / required \| \| The name of the new aggregate. \| \| number\_of\_disks integer \| \| The required number of disks in the new aggregate. \| \| provider\_volume\_type string \| \| The cloud provider volume type. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| state string / required \| Choices:* present * absent \| Whether the specified aggregate should exist or not. \| \| throughput integer \| \| Unit is Mb/s. Valid range 125-1000. Required only when provider\_volume\_type is 'gp3'. \| \| working\_environment\_id string \| \| The public ID of the working environment where the aggregate will be created. \| \| working\_environment\_name string \| \| The working environment name where the aggregate will be created. \| Notes ----- Note * Support check\_mode. * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create Aggregate netapp.cloudmanager.na_cloudmanager_aggregate: state: present name: AnsibleAggregate working_environment_name: testAWS client_id: "{{ client_id }}" number_of_disks: 2 refresh_token: xxx - name: Delete Volume netapp.cloudmanager.na_cloudmanager_aggregate: state: absent name: AnsibleAggregate working_environment_name: testAWS client_id: "{{ client_id }}" refresh_token: xxx ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Success message. Sample: Aggregate Created \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#f79990da9699849e959b928392969ad1d4c4c0ccd1d4c2c5ccd1d4c3cfcc999283968787d1d4c3c1cc94989a)> ansible netapp.cloudmanager.na_cloudmanager_connector_gcp – NetApp Cloud Manager connector for GCP. netapp.cloudmanager.na\_cloudmanager\_connector\_gcp – NetApp Cloud Manager connector for GCP. ============================================================================================== Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_connector_gcp`. New in version 21.4.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create or delete Cloud Manager connector for GCP. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_id string \| \| The NetApp account ID that the Connector will be associated with. If not provided, Cloud Manager uses the first account. If no account exists, Cloud Manager creates a new account. You can find the account ID in the account tab of Cloud Manager at [https://cloudmanager.netapp.com](https://cloudmanager.netapp.com). \| \| associate\_public\_ip boolean \| Choices:* no * yes ← \| Indicates whether to associate a public IP address to the virtual machine. \| \| client\_id string \| \| The client ID of the Cloud Manager Connector. If state is absent, the client id is used to identify the agent and delete it. If state is absent and this parameter is not set, all agents associated with `name` are deleted. Ignored when state is present. \| \| company string / required \| \| The name of the company of the user. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| firewall\_tags boolean \| Choices:* no * yes ← \| Indicates whether to add firewall\_tags to the connector VM (HTTP and HTTP). \| \| gcp\_service\_account\_email string / required added in 21.7.0 of netapp.cloudmanager \| \| The email of the service\_account for the connector instance. This service account is used to allow the Connector to create Cloud Volume ONTAP. aliases: service\_account\_email \| \| gcp\_service\_account\_path string / required added in 21.7.0 of netapp.cloudmanager \| \| The local path of the service\_account JSON file for GCP authorization purposes. This service account is used to create the Connector in GCP. aliases: service\_account\_path \| \| machine\_type string \| Default:"n1-standard-4" \| The machine\_type for the Connector VM. \| \| name string / required \| \| The name of the Cloud Manager connector for GCP to manage. \| \| network\_project\_id string \| \| The project id in GCP associated with the Subnet. If not provided, it is assumed that the Subnet is within the previously specified project id. \| \| project\_id string / required \| \| The GCP project\_id where the connector will be created. \| \| proxy\_certificates list / elements=string \| \| The proxy certificates. A list of certificate file names. \| \| proxy\_password string \| \| The proxy password, if using a proxy to connect to the internet. \| \| proxy\_url string \| \| The proxy URL, if using a proxy to connect to the internet. \| \| proxy\_user\_name string \| \| The proxy user name, if using a proxy to connect to the internet. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| state string \| Choices:* present ← * absent \| Whether the specified Cloud Manager connector for GCP should exist or not. \| \| subnet\_id string \| Default:"default" \| The name of the subnet for the virtual machine. \| \| zone string / required \| \| The GCP zone where the Connector will be created. \| Notes ----- Note * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create NetApp Cloud Manager connector for GCP netapp.cloudmanager.na_cloudmanager_connector_gcp: state: present name: ansible-occm-gcp project_id: xxxxxxx-support zone: us-east4-b company: NetApp gcp_service_account_email: [email protected] gcp_service_account_path: gcp_creds.json proxy_user_name: test proxy_password: test proxy_url: http://abcdefg.com proxy_certificates: ["D-TRUST_Root_Class_3_CA_2_2009.crt", "DigiCertGlobalRootCA.crt", "DigiCertGlobalRootG2.crt"] account_id: account-xxxxXXXX refresh_token: "{{ xxxxxxxxxxxxxxx }}" - name: Delete NetApp Cloud Manager connector for GCP netapp.cloudmanager.na_cloudmanager_connector_gcp: state: absent name: ansible-occm-gcp refresh_token: "{{ xxxxxxxxxxxxxxx }}" client_id: "{{ wwwwwwwwww }}" project_id: xxxxxxx-support zone: us-east4-b company: NetApp gcp_service_account_email: [email protected] gcp_service_account_path: gcp_creds.json account_id: account-xxxxXXXX ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| client\_id string \| success \| Newly created GCP connector id on cloud manager. Sample: FDQE8SwrbjVS6mqUgZoOHQmu2DvBNRRW \| \| client\_ids list / elements=string \| success \| a list of client ids matching the name and provider if the connector already exists. ideally the list should be empty, or contain a single element matching client\_id. Sample: ['FDQE8SwrbjVS6mqUgZoOHQmu2DvBNRRW'] \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#b9d7de94d8d7cad0dbd5dccddcd8d49f9a8a8e829f9a8c8b829f9a8d8182d7dccdd8c9c99f9a8d8f82dad6d4)> ansible netapp.cloudmanager.na_cloudmanager_connector_azure – NetApp Cloud Manager connector for Azure. netapp.cloudmanager.na\_cloudmanager\_connector\_azure – NetApp Cloud Manager connector for Azure. ================================================================================================== Note This plugin is part of the [netapp.cloudmanager collection](https://galaxy.ansible.com/netapp/cloudmanager) (version 21.11.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install netapp.cloudmanager`. To use it in a playbook, specify: `netapp.cloudmanager.na_cloudmanager_connector_azure`. New in version 21.4.0: of netapp.cloudmanager * [Synopsis](#synopsis) * [Parameters](#parameters) * [Notes](#notes) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create or delete Cloud Manager connector for Azure. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| account\_id string / required \| \| The NetApp tenancy account ID. \| \| admin\_password string / required \| \| The password for the Connector. \| \| admin\_username string / required \| \| The user name for the Connector. \| \| associate\_public\_ip\_address boolean \| Choices:* no * yes ← \| Indicates whether to associate the public IP address to the virtual machine. \| \| client\_id string \| \| The unique client ID of the Connector. \| \| company string / required \| \| The name of the company of the user. \| \| environment string added in 21.8.0 of netapp.cloudmanager \| Choices:* prod ← * stage \| The environment for NetApp Cloud Manager API operations. \| \| feature\_flags dictionary added in 21.11.0 of netapp.cloudmanager \| \| Enable or disable a new feature. This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. Supported keys and values are subject to change without notice. Unknown keys are ignored. \| \| location string / required \| \| The location where the Cloud Manager Connector will be created. \| \| name string / required \| \| The name of the Cloud Manager connector for Azure to manage. \| \| network\_security\_group\_name string / required \| \| The name of the security group for the deployment. \| \| network\_security\_resource\_group string \| \| The resource group in Azure associated with the security group. If not provided, its assumed that the security group is within the previously specified resource group. \| \| proxy\_certificates list / elements=string \| \| The proxy certificates, a list of certificate file names. \| \| proxy\_password string \| \| The proxy password, if using a proxy to connect to the internet. \| \| proxy\_url string \| \| The proxy URL, if using a proxy to connect to the internet. \| \| proxy\_user\_name string \| \| The proxy user name, if using a proxy to connect to the internet. \| \| refresh\_token string \| \| The refresh token for NetApp Cloud Manager API operations. \| \| resource\_group string / required \| \| The resource group in Azure where the resources will be created. \| \| sa\_client\_id string \| \| The service account secret client ID for NetApp Cloud Manager API operations. \| \| sa\_secret\_key string \| \| The service account secret key for NetApp Cloud Manager API operations. \| \| state string \| Choices:* present ← * absent \| Whether the specified Cloud Manager connector for Azure should exist or not. \| \| subnet\_name string / required added in 21.7.0 of netapp.cloudmanager \| \| The name of the subnet for the virtual machine. For example, in /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/xxx/subnets/default, only default is needed. aliases: subnet\_id \| \| subscription\_id string / required \| \| The ID of the Azure subscription. \| \| virtual\_machine\_size string \| Default:"Standard\_DS3\_v2" \| The virtual machine type. (for example, Standard\_DS3\_v2). At least 4 CPU and 16 GB of memory are required. \| \| vnet\_name string / required added in 21.7.0 of netapp.cloudmanager \| \| The name of the virtual network. for example, in /subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Network/virtualNetworks/default, only default is needed. aliases: vnet\_id \| \| vnet\_resource\_group string \| \| The resource group in Azure associated with the virtual network. If not provided, its assumed that the VNet is within the previously specified resource group. \| Notes ----- Note * The modules prefixed with na\_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds. * If sa\_client\_id and sa\_secret\_key are provided, service account will be used in operations. refresh\_token will be ignored. Examples -------- ``` - name: Create NetApp Cloud Manager connector for Azure. netapp.cloudmanager.na_cloudmanager_connector_azure: state: present refresh_token: "{{ xxxxxxxxxxxxxxx }}" name: bsuhas_ansible_occm location: westus resource_group: occm_group_westus subnet_name: subnetxxxxx vnet_name: Vnetxxxxx subscription_id: "{{ xxxxxxxxxxxxxxxxx }}" account_id: "{{ account-xxxxxxx }}" company: NetApp admin_password: Netapp123456 admin_username: bsuhas network_security_group_name: OCCM_SG proxy_url: abc.com proxy_user_name: xyz proxy_password: abcxyz proxy_certificates: [abc.crt.txt, xyz.crt.txt] - name: Delete NetApp Cloud Manager connector for Azure. netapp.cloudmanager.na_cloudmanager_connector_azure: state: absent name: ansible location: westus resource_group: occm_group_westus network_security_group_name: OCCM_SG subnet_name: subnetxxxxx company: NetApp admin_password: Netapp123456 admin_username: bsuhas vnet_name: Vnetxxxxx subscription_id: "{{ xxxxxxxxxxxxxxxxx }}" account_id: "{{ account-xxxxxxx }}" refresh_token: "{{ xxxxxxxxxxxxxxx }}" client_id: xxxxxxxxxxxxxxxxxxx ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| msg string \| success \| Newly created Azure connector id in cloud manager. Sample: xxxxxxxxxxxxxxxx \| ### Authors * NetApp Ansible Team (@carchi8py) <[[email protected]](https://docs.ansible.com/cdn-cgi/l/email-protection#6e0009430f001d070c020b1a0b0f03484d5d5955484d5b5c55484d5a5655000b1a0f1e1e484d5a58550d0103)> ansible Collections in the Inspur Namespace Collections in the Inspur Namespace =================================== These are the collections with docs hosted on [docs.ansible.com](https://docs.ansible.com/) in the inspur namespace. * [inspur.sm](sm/index#plugins-in-inspur-sm) ansible inspur.sm.reset_bmc – BMC reset. inspur.sm.reset\_bmc – BMC reset. ================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.reset_bmc`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * BMC reset on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Reset bmc test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Reset bmc" inspur.sm.reset_bmc: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.fru_info – Get fru information. inspur.sm.fru\_info – Get fru information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.fru_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get fru information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Fru info test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get fru information" inspur.sm.fru_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.ad_group – Manage active directory group information. inspur.sm.ad\_group – Manage active directory group information. ================================================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.ad_group`. New in version 1.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage active directory group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| domain string \| \| Group domain. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| kvm string \| Choices:* enable * disable \| Kvm privilege. \| \| name string / required \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| pri string \| Choices:* administrator * user * operator * oem * none \| Group privilege. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| state string \| Choices:* present ← * absent \| Whether the active directory group should exist or not, taking action if the state is different from what is stated. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| vm string \| Choices:* enable * disable \| Vmedia privilege. \| Examples -------- ``` - name: Ad group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Add active directory group information" inspur.sm.ad_group: state: "present" name: "wbs" domain: "inspur.com" pri: "administrator" kvm: "enable" vm: "disable" provider: "{{ ism }}" - name: "Set active directory group information" inspur.sm.ad_group: state: "present" name: "wbs" pri: "user" kvm: "disable" provider: "{{ ism }}" - name: "Delete active directory group information" inspur.sm.ad_group: state: "absent" name: "wbs" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_psu_peak – Set psu peak information. inspur.sm.edit\_psu\_peak – Set psu peak information. ===================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_psu_peak`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set psu peak information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| status string / required \| Choices:* enable * disable \| Power peak status. \| \| time integer \| \| Maximum random time, range of values(1-600), unit(second). \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Psu peak test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set psu peak information" inspur.sm.edit_psu_peak: status: "disable" provider: "{{ ism }}" - name: "Set psu peak information" inspur.sm.edit_psu_peak: status: "enable" time: 10 provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.cpu_info – Get CPU information. inspur.sm.cpu\_info – Get CPU information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.cpu_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get CPU information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: CPU test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get cpu information" inspur.sm.cpu_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.threshold_info – Get threshold information. inspur.sm.threshold\_info – Get threshold information. ====================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.threshold_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get threshold information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Threshold test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get threshold information" inspur.sm.threshold_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_pass_user – Change user password. inspur.sm.edit\_pass\_user – Change user password. ================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_pass_user`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.user](user_module#ansible-collections-inspur-sm-user-module) module. Alternative Use [inspur.sm.user](user_module#ansible-collections-inspur-sm-user-module) instead. Synopsis -------- * Change user password on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| uname string / required \| \| User name. \| \| upass string / required \| \| User password. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Edit user password test hosts: ism no_log: true connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Change user password" inspur.sm.edit_pass_user: uname: "wbs" upass: my_password provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.alert_policy_info – Get alert policy. inspur.sm.alert\_policy\_info – Get alert policy. ================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.alert_policy_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get alert policy on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Alert test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get alert policy" inspur.sm.alert_policy_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.backup – Backup server settings. inspur.sm.backup – Backup server settings. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.backup`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Backup server settings on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bak\_file string / required \| \| Backup file or bak folder. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| item string / required \| Choices:* all * network * service * ntp * snmptrap * dns * smtp * ad * ldap * user * bios * kvm * ipmi * authentication * syslog \| Export item. The values for M5 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'dns', 'smtp', 'ad', 'ldap', 'user','bios'. The values for M6 modules are 'all', 'network', 'service', 'ntp', 'snmptrap', 'kvm', 'ipmi', 'authentication', 'syslog'. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Backup test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Backup server settings" inspur.sm.backup: bak_file: "/home/wbs/" item: "all" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.bmc_info – Get BMC information. inspur.sm.bmc\_info – Get BMC information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.bmc_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get BMC information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Bmc info test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get BMC information" inspur.sm.bmc_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.clear_system_log – Clear BMC system log. inspur.sm.clear\_system\_log – Clear BMC system log. ==================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.clear_system_log`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Clear BMC system log on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| level string \| Choices:* alert ← * critical * error * notice * warning * debug * emergency * info * all \| Log level. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Clear BMC system log test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Clear BMC system log" inspur.sm.clear_system_log: level: "alert" provider: "{{ ism }}" - name: "Clear BMC system log" inspur.sm.clear_system_log: level: "all" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_network_bond – Set network bond. inspur.sm.edit\_network\_bond – Set network bond. ================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_network_bond`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set network bond on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auto\_config string \| Choices:* enable * disable \| Enable this option to configure the interfaces in service configuration automatically. \| \| bond string \| Choices:* enable * disable \| Network bond status,If VLAN is enabled for slave interfaces, then Bonding cannot be enabled. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| interface string \| Choices:* shared * dedicated * both \| Interface name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: bond test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set network bond" inspur.sm.edit_network_bond: bond: "enable" interface: "dedicated" auto_config: "enable" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_uid – Set UID. inspur.sm.edit\_uid – Set UID. ============================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_uid`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set UID on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| led string / required \| Choices:* on * off \| Turn on or turn off the led. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| time integer \| \| Set led blink time(second). \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: UID test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set uid" inspur.sm.edit_uid: led: "on" time: 10 provider: "{{ ism }}" - name: "Set uid" inspur.sm.edit_uid: led: "off" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.user_info – Get user information. inspur.sm.user\_info – Get user information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.user_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get user information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: User test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get user information" inspur.sm.user_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.virtual_media_info – Get Virtual Media information. inspur.sm.virtual\_media\_info – Get Virtual Media information. =============================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.virtual_media_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get Virtual Media information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Media test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get Virtual Media information" inspur.sm.virtual_media_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.raid_info – Get RAID/HBA card and controller information. inspur.sm.raid\_info – Get RAID/HBA card and controller information. ==================================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.raid_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get RAID/HBA card and controller information information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Raid test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get raid information" inspur.sm.raid_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.add_ldap_group – Add ldap group information. inspur.sm.add\_ldap\_group – Add ldap group information. ======================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.add_ldap_group`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.ldap\_group](ldap_group_module#ansible-collections-inspur-sm-ldap-group-module) module. Alternative Use [inspur.sm.ldap\_group](ldap_group_module#ansible-collections-inspur-sm-ldap-group-module) instead. Synopsis -------- * Add ldap group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| base string / required \| \| Search Base. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| kvm string / required \| Choices:* enable * disable \| Kvm privilege. \| \| name string / required \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| pri string / required \| Choices:* administrator * user * operator * oem * none \| Group privilege. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| vm string / required \| Choices:* enable * disable \| Vmedia privilege. \| Examples -------- ``` - name: Ldap group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Add ldap group information" inspur.sm.add_ldap_group: name: "wbs" base: "cn=manager" pri: "administrator" kvm: "enable" vm: "disable" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_boot_image – Set bmc boot image. inspur.sm.edit\_boot\_image – Set bmc boot image. ================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_boot_image`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set bmc boot image on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| image integer / required \| Choices:* 0 * 1 * 2 * 3 * 4 * 5 \| BMC boot image. 0-Higher firmware version;1-Image 1;2-Image 2;3-Lower firmware version;4-Latest updated firmware;5-Not latest updated firmware. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Boot image test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set bmc boot image" inspur.sm.edit_boot_image: image: 2 provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible Inspur.Sm Inspur.Sm ========= Collection version 1.3.0 Plugin Index ------------ These are the plugins in the inspur.sm collection ### Modules * [ad\_group](ad_group_module#ansible-collections-inspur-sm-ad-group-module) – Manage active directory group information. * [ad\_group\_info](ad_group_info_module#ansible-collections-inspur-sm-ad-group-info-module) – Get active directory group information. * [ad\_info](ad_info_module#ansible-collections-inspur-sm-ad-info-module) – Get active directory information. * [adapter\_info](adapter_info_module#ansible-collections-inspur-sm-adapter-info-module) – Get adapter information. * [add\_ad\_group](add_ad_group_module#ansible-collections-inspur-sm-add-ad-group-module) – Add active directory group information. * [add\_ldap\_group](add_ldap_group_module#ansible-collections-inspur-sm-add-ldap-group-module) – Add ldap group information. * [add\_ldisk](add_ldisk_module#ansible-collections-inspur-sm-add-ldisk-module) – Create logical disk. * [add\_user](add_user_module#ansible-collections-inspur-sm-add-user-module) – Create user. * [add\_user\_group](add_user_group_module#ansible-collections-inspur-sm-add-user-group-module) – Create user group. * [alert\_policy\_info](alert_policy_info_module#ansible-collections-inspur-sm-alert-policy-info-module) – Get alert policy. * [audit\_log\_info](audit_log_info_module#ansible-collections-inspur-sm-audit-log-info-module) – Get BMC audit log information. * [auto\_capture\_info](auto_capture_info_module#ansible-collections-inspur-sm-auto-capture-info-module) – Get auto capture screen information. * [backplane\_info](backplane_info_module#ansible-collections-inspur-sm-backplane-info-module) – Get disk backplane information. * [backup](backup_module#ansible-collections-inspur-sm-backup-module) – Backup server settings. * [bios\_export](bios_export_module#ansible-collections-inspur-sm-bios-export-module) – Export BIOS config. * [bios\_import](bios_import_module#ansible-collections-inspur-sm-bios-import-module) – Import BIOS config. * [bios\_info](bios_info_module#ansible-collections-inspur-sm-bios-info-module) – Get BIOS setup. * [bmc\_info](bmc_info_module#ansible-collections-inspur-sm-bmc-info-module) – Get BMC information. * [boot\_image\_info](boot_image_info_module#ansible-collections-inspur-sm-boot-image-info-module) – Get bmc boot image information. * [boot\_option\_info](boot_option_info_module#ansible-collections-inspur-sm-boot-option-info-module) – Get BIOS boot options. * [clear\_audit\_log](clear_audit_log_module#ansible-collections-inspur-sm-clear-audit-log-module) – Clear BMC audit log. * [clear\_event\_log](clear_event_log_module#ansible-collections-inspur-sm-clear-event-log-module) – Clear event log. * [clear\_system\_log](clear_system_log_module#ansible-collections-inspur-sm-clear-system-log-module) – Clear BMC system log. * [collect\_blackbox](collect_blackbox_module#ansible-collections-inspur-sm-collect-blackbox-module) – Collect blackbox log. * [collect\_log](collect_log_module#ansible-collections-inspur-sm-collect-log-module) – Collect logs. * [connect\_media\_info](connect_media_info_module#ansible-collections-inspur-sm-connect-media-info-module) – Get remote images redirection information. * [cpu\_info](cpu_info_module#ansible-collections-inspur-sm-cpu-info-module) – Get CPU information. * [del\_ad\_group](del_ad_group_module#ansible-collections-inspur-sm-del-ad-group-module) – Delete active directory group information. * [del\_ldap\_group](del_ldap_group_module#ansible-collections-inspur-sm-del-ldap-group-module) – Delete ldap group information. * [del\_session](del_session_module#ansible-collections-inspur-sm-del-session-module) – Delete session. * [del\_user](del_user_module#ansible-collections-inspur-sm-del-user-module) – Delete user. * [del\_user\_group](del_user_group_module#ansible-collections-inspur-sm-del-user-group-module) – Delete user group. * [dns\_info](dns_info_module#ansible-collections-inspur-sm-dns-info-module) – Get dns information. * [download\_auto\_screenshot](download_auto_screenshot_module#ansible-collections-inspur-sm-download-auto-screenshot-module) – Download auto screenshots. * [download\_manual\_screenshot](download_manual_screenshot_module#ansible-collections-inspur-sm-download-manual-screenshot-module) – Download manual screenshots. * [edit\_ad](edit_ad_module#ansible-collections-inspur-sm-edit-ad-module) – Set active directory information. * [edit\_ad\_group](edit_ad_group_module#ansible-collections-inspur-sm-edit-ad-group-module) – Set active directory group information. * [edit\_alert\_policy](edit_alert_policy_module#ansible-collections-inspur-sm-edit-alert-policy-module) – Set alert policy. * [edit\_auto\_capture](edit_auto_capture_module#ansible-collections-inspur-sm-edit-auto-capture-module) – Set auto capture screen. * [edit\_bios](edit_bios_module#ansible-collections-inspur-sm-edit-bios-module) – Set BIOS setup attributes. * [edit\_boot\_image](edit_boot_image_module#ansible-collections-inspur-sm-edit-boot-image-module) – Set bmc boot image. * [edit\_boot\_option](edit_boot_option_module#ansible-collections-inspur-sm-edit-boot-option-module) – Set BIOS boot options. * [edit\_connect\_media](edit_connect_media_module#ansible-collections-inspur-sm-edit-connect-media-module) – Start/Stop virtual media Image * [edit\_dns](edit_dns_module#ansible-collections-inspur-sm-edit-dns-module) – Set dns information. * [edit\_event\_log\_policy](edit_event_log_policy_module#ansible-collections-inspur-sm-edit-event-log-policy-module) – Set event log policy. * [edit\_fan](edit_fan_module#ansible-collections-inspur-sm-edit-fan-module) – Set fan information. * [edit\_fru](edit_fru_module#ansible-collections-inspur-sm-edit-fru-module) – Set fru settings. * [edit\_ipv4](edit_ipv4_module#ansible-collections-inspur-sm-edit-ipv4-module) – Set ipv4 information. * [edit\_ipv6](edit_ipv6_module#ansible-collections-inspur-sm-edit-ipv6-module) – Set ipv6 information. * [edit\_kvm](edit_kvm_module#ansible-collections-inspur-sm-edit-kvm-module) – Set KVM. * [edit\_ldap](edit_ldap_module#ansible-collections-inspur-sm-edit-ldap-module) – Set ldap information. * [edit\_ldap\_group](edit_ldap_group_module#ansible-collections-inspur-sm-edit-ldap-group-module) – Set ldap group information. * [edit\_ldisk](edit_ldisk_module#ansible-collections-inspur-sm-edit-ldisk-module) – Set logical disk. * [edit\_log\_setting](edit_log_setting_module#ansible-collections-inspur-sm-edit-log-setting-module) – Set bmc system and audit log setting. * [edit\_manual\_capture](edit_manual_capture_module#ansible-collections-inspur-sm-edit-manual-capture-module) – Set manual capture screen. * [edit\_media\_instance](edit_media_instance_module#ansible-collections-inspur-sm-edit-media-instance-module) – Set Virtual Media Instance * [edit\_ncsi](edit_ncsi_module#ansible-collections-inspur-sm-edit-ncsi-module) – Set ncsi information. * [edit\_network](edit_network_module#ansible-collections-inspur-sm-edit-network-module) – Set network information. * [edit\_network\_bond](edit_network_bond_module#ansible-collections-inspur-sm-edit-network-bond-module) – Set network bond. * [edit\_network\_link](edit_network_link_module#ansible-collections-inspur-sm-edit-network-link-module) – Set network link. * [edit\_ntp](edit_ntp_module#ansible-collections-inspur-sm-edit-ntp-module) – Set NTP. * [edit\_pass\_user](edit_pass_user_module#ansible-collections-inspur-sm-edit-pass-user-module) – Change user password. * [edit\_pdisk](edit_pdisk_module#ansible-collections-inspur-sm-edit-pdisk-module) – Set physical disk. * [edit\_power\_budget](edit_power_budget_module#ansible-collections-inspur-sm-edit-power-budget-module) – Set power budget information. * [edit\_power\_restore](edit_power_restore_module#ansible-collections-inspur-sm-edit-power-restore-module) – Set power restore information. * [edit\_power\_status](edit_power_status_module#ansible-collections-inspur-sm-edit-power-status-module) – Set power status information. * [edit\_preserve\_config](edit_preserve_config_module#ansible-collections-inspur-sm-edit-preserve-config-module) – Set preserve config. * [edit\_priv\_user](edit_priv_user_module#ansible-collections-inspur-sm-edit-priv-user-module) – Change user privilege. * [edit\_psu\_config](edit_psu_config_module#ansible-collections-inspur-sm-edit-psu-config-module) – Set psu config information. * [edit\_psu\_peak](edit_psu_peak_module#ansible-collections-inspur-sm-edit-psu-peak-module) – Set psu peak information. * [edit\_restore\_factory\_default](edit_restore_factory_default_module#ansible-collections-inspur-sm-edit-restore-factory-default-module) – Set preserver config. * [edit\_service](edit_service_module#ansible-collections-inspur-sm-edit-service-module) – Set service settings. * [edit\_smtp](edit_smtp_module#ansible-collections-inspur-sm-edit-smtp-module) – Set SMTP information. * [edit\_smtp\_com](edit_smtp_com_module#ansible-collections-inspur-sm-edit-smtp-com-module) – Set SMTP information. * [edit\_smtp\_dest](edit_smtp_dest_module#ansible-collections-inspur-sm-edit-smtp-dest-module) – Set SMTP information. * [edit\_snmp](edit_snmp_module#ansible-collections-inspur-sm-edit-snmp-module) – Set snmp. * [edit\_snmp\_trap](edit_snmp_trap_module#ansible-collections-inspur-sm-edit-snmp-trap-module) – Set snmp trap. * [edit\_threshold](edit_threshold_module#ansible-collections-inspur-sm-edit-threshold-module) – Set threshold information. * [edit\_uid](edit_uid_module#ansible-collections-inspur-sm-edit-uid-module) – Set UID. * [edit\_user\_group](edit_user_group_module#ansible-collections-inspur-sm-edit-user-group-module) – Set user group. * [edit\_virtual\_media](edit_virtual_media_module#ansible-collections-inspur-sm-edit-virtual-media-module) – Set virtual media. * [edit\_vlan](edit_vlan_module#ansible-collections-inspur-sm-edit-vlan-module) – Set vlan information. * [event\_log\_info](event_log_info_module#ansible-collections-inspur-sm-event-log-info-module) – Get event log information. * [event\_log\_policy\_info](event_log_policy_info_module#ansible-collections-inspur-sm-event-log-policy-info-module) – Get event log policy information. * [fan\_info](fan_info_module#ansible-collections-inspur-sm-fan-info-module) – Get fan information. * [fru\_info](fru_info_module#ansible-collections-inspur-sm-fru-info-module) – Get fru information. * [fw\_version\_info](fw_version_info_module#ansible-collections-inspur-sm-fw-version-info-module) – Get firmware version information. * [gpu\_info](gpu_info_module#ansible-collections-inspur-sm-gpu-info-module) – Get GPU information. * [hard\_disk\_info](hard_disk_info_module#ansible-collections-inspur-sm-hard-disk-info-module) – Get hard disk information. * [kvm\_info](kvm_info_module#ansible-collections-inspur-sm-kvm-info-module) – Get KVM information. * [ldap\_group](ldap_group_module#ansible-collections-inspur-sm-ldap-group-module) – Manage ldap group information. * [ldap\_group\_info](ldap_group_info_module#ansible-collections-inspur-sm-ldap-group-info-module) – Get ldap group information. * [ldap\_info](ldap_info_module#ansible-collections-inspur-sm-ldap-info-module) – Get ldap information. * [ldisk\_info](ldisk_info_module#ansible-collections-inspur-sm-ldisk-info-module) – Get logical disks information. * [log\_setting\_info](log_setting_info_module#ansible-collections-inspur-sm-log-setting-info-module) – Get bmc log setting information. * [media\_instance\_info](media_instance_info_module#ansible-collections-inspur-sm-media-instance-info-module) – Get Virtual Media Instance information. * [mem\_info](mem_info_module#ansible-collections-inspur-sm-mem-info-module) – Get memory information. * [ncsi\_info](ncsi_info_module#ansible-collections-inspur-sm-ncsi-info-module) – Get ncsi information. * [network\_bond\_info](network_bond_info_module#ansible-collections-inspur-sm-network-bond-info-module) – Get network bond information. * [network\_info](network_info_module#ansible-collections-inspur-sm-network-info-module) – Get network information. * [network\_link\_info](network_link_info_module#ansible-collections-inspur-sm-network-link-info-module) – Get network link information. * [ntp\_info](ntp_info_module#ansible-collections-inspur-sm-ntp-info-module) – Get NTP information. * [pcie\_info](pcie_info_module#ansible-collections-inspur-sm-pcie-info-module) – Get PCIE information. * [pdisk\_info](pdisk_info_module#ansible-collections-inspur-sm-pdisk-info-module) – Get physical disks information. * [power\_budget\_info](power_budget_info_module#ansible-collections-inspur-sm-power-budget-info-module) – Get power budget information. * [power\_consumption\_info](power_consumption_info_module#ansible-collections-inspur-sm-power-consumption-info-module) – Get power consumption information. * [power\_restore\_info](power_restore_info_module#ansible-collections-inspur-sm-power-restore-info-module) – Get power restore information. * [power\_status\_info](power_status_info_module#ansible-collections-inspur-sm-power-status-info-module) – Get power status information. * [preserve\_config\_info](preserve_config_info_module#ansible-collections-inspur-sm-preserve-config-info-module) – Get preserve config information. * [psu\_config\_info](psu_config_info_module#ansible-collections-inspur-sm-psu-config-info-module) – Get psu config information. * [psu\_info](psu_info_module#ansible-collections-inspur-sm-psu-info-module) – Get psu information. * [psu\_peak\_info](psu_peak_info_module#ansible-collections-inspur-sm-psu-peak-info-module) – Get psu peak information. * [raid\_info](raid_info_module#ansible-collections-inspur-sm-raid-info-module) – Get RAID/HBA card and controller information. * [reset\_bmc](reset_bmc_module#ansible-collections-inspur-sm-reset-bmc-module) – BMC reset. * [reset\_kvm](reset_kvm_module#ansible-collections-inspur-sm-reset-kvm-module) – KVM reset. * [restore](restore_module#ansible-collections-inspur-sm-restore-module) – Restore server settings. * [self\_test\_info](self_test_info_module#ansible-collections-inspur-sm-self-test-info-module) – Get self test information. * [sensor\_info](sensor_info_module#ansible-collections-inspur-sm-sensor-info-module) – Get sensor information. * [server\_info](server_info_module#ansible-collections-inspur-sm-server-info-module) – Get server status information. * [service\_info](service_info_module#ansible-collections-inspur-sm-service-info-module) – Get service information. * [session\_info](session_info_module#ansible-collections-inspur-sm-session-info-module) – Get online session information. * [smtp\_info](smtp_info_module#ansible-collections-inspur-sm-smtp-info-module) – Get SMTP information. * [snmp\_info](snmp_info_module#ansible-collections-inspur-sm-snmp-info-module) – Get snmp get/set information. * [snmp\_trap\_info](snmp_trap_info_module#ansible-collections-inspur-sm-snmp-trap-info-module) – Get snmp trap information. * [system\_log\_info](system_log_info_module#ansible-collections-inspur-sm-system-log-info-module) – Get BMC system log information. * [temp\_info](temp_info_module#ansible-collections-inspur-sm-temp-info-module) – Get temp information. * [threshold\_info](threshold_info_module#ansible-collections-inspur-sm-threshold-info-module) – Get threshold information. * [uid\_info](uid_info_module#ansible-collections-inspur-sm-uid-info-module) – Get UID information. * [update\_cpld](update_cpld_module#ansible-collections-inspur-sm-update-cpld-module) – Update CPLD. * [update\_fw](update_fw_module#ansible-collections-inspur-sm-update-fw-module) – Update firmware. * [user](user_module#ansible-collections-inspur-sm-user-module) – Manage user. * [user\_group](user_group_module#ansible-collections-inspur-sm-user-group-module) – Manage user group. * [user\_group\_info](user_group_info_module#ansible-collections-inspur-sm-user-group-info-module) – Get user group information. * [user\_info](user_info_module#ansible-collections-inspur-sm-user-info-module) – Get user information. * [virtual\_media\_info](virtual_media_info_module#ansible-collections-inspur-sm-virtual-media-info-module) – Get Virtual Media information. * [volt\_info](volt_info_module#ansible-collections-inspur-sm-volt-info-module) – Get volt information. See also List of [collections](../../index#list-of-collections) with docs hosted here.	programming_docs
ansible inspur.sm.volt_info – Get volt information. inspur.sm.volt\_info – Get volt information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.volt_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get volt information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Volt test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get volt information" inspur.sm.volt_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_ldisk – Set logical disk. inspur.sm.edit\_ldisk – Set logical disk. ========================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_ldisk`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set logical disk on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| ctrl\_id integer \| \| Raid controller ID. Required when Info=None. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| info string \| Choices:* show \| Show controller and ldisk info. \| \| ldisk\_id integer \| \| Logical disk ID. Required when Info=None. \| \| option string \| Choices:* LOC * STL * FI * SFI * SI * DEL \| Set operation options fo logical disk, LOC is Locate Logical Drive,STL is Stop Locate LogicalDrive, FI is Fast Initialization,SFI is Slow/Full Initialization, SI is Stop Initialization,DEL is Delete LogicalDrive. Required when Info=None. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Edit ldisk test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Show ldisk information" inspur.sm.edit_ldisk: info: "show" provider: "{{ ism }}" - name: "Edit ldisk" inspur.sm.edit_ldisk: ctrl_id: 0 ldisk_id: 1 option: "LOC" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.audit_log_info – Get BMC audit log information. inspur.sm.audit\_log\_info – Get BMC audit log information. =========================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.audit_log_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get BMC audit log information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| audit\_file string \| \| Store logs to a file. \| \| count integer \| \| Get the most recent log of a specified number. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| log\_time string \| \| Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Bmc audit log test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get bmc audit log information" inspur.sm.audit_log_info: log_time: "2020-06-01T12:30+08:00" provider: "{{ ism }}" - name: "Get bmc audit log information" inspur.sm.audit_log_info: count: 30 provider: "{{ ism }}" - name: "Get bmc audit log information" inspur.sm.audit_log_info: audit_file: "/home/wbs/wbs.log" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_fan – Set fan information. inspur.sm.edit\_fan – Set fan information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_fan`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set fan information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| fan\_speed integer \| \| fan speed (duty ratio), range in 1 - 100. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| id integer \| \| fan id 255 is for all fans,0~n. \| \| mode string \| Choices:* Automatic * Manual \| Control mode, Manual or Automatic ,Manual must be used with fans\_peed. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Fan test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set fan information" inspur.sm.edit_fan: mode: "Automatic" provider: "{{ ism }}" - name: "Set fan information" inspur.sm.edit_fan: mode: "Manual" id: 1 fan_speed: 80 provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_ipv4 – Set ipv4 information. inspur.sm.edit\_ipv4 – Set ipv4 information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_ipv4`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set ipv4 information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| interface\_name string / required \| Choices:* eth0 * eth1 * bond0 \| Set interface\_name. \| \| ipv4\_address string \| \| If DHCP is disabled, specify a static IPv4 address to be configured for the selected interface. Required when ipv4\_dhcp\_enable=static. \| \| ipv4\_dhcp\_enable string \| Choices:* dhcp * static \| Enable 'Enable DHCP' to dynamically configure IPv4 address using Dynamic Host Configuration Protocol (DHCP). \| \| ipv4\_gateway string \| \| If DHCP is disabled, specify a static Default Gateway to be configured for the selected interface. Required when ipv4\_dhcp\_enable=static. \| \| ipv4\_status string \| Choices:* enable * disable \| Enable or disable IPV4. \| \| ipv4\_subnet string \| \| If DHCP is disabled, specify a static Subnet Mask to be configured for the selected interface. Required when ipv4\_dhcp\_enable=static. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Ipv4 test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set ipv4 information" inspur.sm.edit_ipv4: interface_name: "eth0" ipv4_status: "disable" provider: "{{ ism }}" - name: "Set ipv4 information" inspur.sm.edit_ipv4: interface_name: "eth0" ipv4_status: "enable" ipv4_dhcp_enable: "dhcp" provider: "{{ ism }}" - name: "Set ipv4 information" inspur.sm.edit_ipv4: interface_name: "eth0" ipv4_status: "enable" ipv4_dhcp_enable: "static" ipv4_address: "100.2.36.10" ipv4_subnet: "255.255.255.0" ipv4_gateway: "100.2.36.1" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_ncsi – Set ncsi information. inspur.sm.edit\_ncsi – Set ncsi information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_ncsi`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set ncsi information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| channel\_number integer \| \| Channel number, like 0,1,2... \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| interface\_name string \| \| Interface name, for example eth0. \| \| mode string \| Choices:* auto * manual \| NCSI mode, auto-Auto Failover, manual-Manual Switch. \| \| nic\_type string \| Choices:* PHY * OCP * PCIE * auto \| Nic type. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: NCSI test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set ncsi information" inspur.sm.edit_ncsi: mode: "manual" nic_type: "PCIE" interface_name: "eth0" channel_number: 1 provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.power_consumption_info – Get power consumption information. inspur.sm.power\_consumption\_info – Get power consumption information. ======================================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.power_consumption_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get power consumption information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Power consumption test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get power consumption information" inspur.sm.power_consumption_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_smtp_dest – Set SMTP information. inspur.sm.edit\_smtp\_dest – Set SMTP information. ================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_smtp_dest`. New in version 1.2.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set SMTP dest information on Inspur server. * Only the M6 models support this feature. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| Email address. \| \| description string \| \| Description information. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| id integer / required \| Choices:* 1 * 2 * 3 * 4 \| Email destination id. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| status string \| Choices:* enable * disable \| Email enable. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Smtp dest test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set smtp dest information" inspur.sm.edit_smtp_dest: id: 1 status: "disable" provider: "{{ ism }}" - name: "Set smtp dest information" inspur.sm.edit_smtp_dest: id: 1 status: "enable" address: "100.2.2.2" description": "test" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.ncsi_info – Get ncsi information. inspur.sm.ncsi\_info – Get ncsi information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.ncsi_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get ncsi information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: NCSI test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get ncsi information" inspur.sm.ncsi_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.session_info – Get online session information. inspur.sm.session\_info – Get online session information. ========================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.session_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get online session information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Session test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get session information" inspur.sm.session_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.boot_image_info – Get bmc boot image information. inspur.sm.boot\_image\_info – Get bmc boot image information. ============================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.boot_image_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get bmc boot image information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Boot image test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get bmc boot image information" inspur.sm.boot_image_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.media_instance_info – Get Virtual Media Instance information. inspur.sm.media\_instance\_info – Get Virtual Media Instance information. ========================================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.media_instance_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get Virtual Media Instance information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Media instance test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get Virtual Media Instance information" inspur.sm.media_instance_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.power_status_info – Get power status information. inspur.sm.power\_status\_info – Get power status information. ============================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.power_status_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get power status information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Power status test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get power status information" inspur.sm.power_status_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.power_restore_info – Get power restore information. inspur.sm.power\_restore\_info – Get power restore information. =============================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.power_restore_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get power restore information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Power restore test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get power restore information" inspur.sm.power_restore_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.collect_log – Collect logs. inspur.sm.collect\_log – Collect logs. ====================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.collect_log`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Collect logs on Inspur server,it takes about 5 minutes. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| file\_url string / required \| \| File download path or path with filename , e.g. filepath/filename.tar. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Collect test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Collect logs" inspur.sm.collect_log: file_url: "/home/wbs/test.tar" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_network – Set network information. inspur.sm.edit\_network – Set network information. ================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_network`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set netowrk information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| interface\_name string / required \| Choices:* eth0 * eth1 * bond0 \| Set interface\_name. \| \| lan\_enable string / required \| Choices:* enable * disable \| Enable or disable this interface. If disable , you cannot use this interface any more. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Network test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set network information" inspur.sm.edit_network: interface_name: "eth0" lan_enable: "enable" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.psu_config_info – Get psu config information. inspur.sm.psu\_config\_info – Get psu config information. ========================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.psu_config_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get psu config information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Psu config test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get psu config information" inspur.sm.psu_config_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.dns_info – Get dns information. inspur.sm.dns\_info – Get dns information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.dns_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get dns information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: DNS test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get dns information" inspur.sm.dns_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.restore – Restore server settings. inspur.sm.restore – Restore server settings. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.restore`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Restore server settings on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| bak\_file string / required \| \| select backup file or bak folder. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| item string \| Choices:* all * network * dns * service * ntp * smtp * snmptrap * ad * ldap * user * bios \| select export item. Only the M5 model supports this parameter. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Backup test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Restore server settings" inspur.sm.restore: bak_file: "/home/wbs/backfile" item: "all" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.edit_smtp_com – Set SMTP information. inspur.sm.edit\_smtp\_com – Set SMTP information. ================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_smtp_com`. New in version 1.2.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set SMTP com information on Inspur server. * Only the M6 models support this feature. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| asset\_tag string \| \| product asset label, \| \| email string \| \| Sender email. \| \| event\_level string \| \| Events above this level will be sent. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| host\_name string \| \| Server name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| serial\_number string \| \| Serial number. \| \| server\_auth string \| Choices:* enable * disable \| SMTP server authentication. \| \| server\_ip string \| \| SMTP server IP. \| \| server\_password string \| \| SMTP server Password,lenth be 4 to 64 bits,cannot contain ' '(space). Required when server\_auth=enable. \| \| server\_port integer \| \| SMTP server port,The Identification for retry count configuration(1-65535). \| \| server\_secure\_port integer \| \| SMTP server sesure port,The Identification for retry count configuration(1-65535). \| \| server\_username string \| \| SMTP server Username,lenth be 4 to 64 bits, must start with letters and cannot contain ','(comma) ':'(colon) ' '(space) ';'(semicolon) '\'(backslash). Required when server\_auth=enable. \| \| ssl\_tls\_enable string \| Choices:* enable * disable \| SMTP SSLTLS Enable. ssl\_tls\_enable=disable, when star\_tls\_enable=enable. \| \| star\_tls\_enable string \| Choices:* enable * disable \| SMTP STARTTLS Enable. star\_tls\_enable=disable, when ssl\_tls\_enable=enable. \| \| status string / required \| Choices:* enable * disable \| SMTP Support. \| \| subject string \| \| Email theme. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Smtp com test hosts: ism no_log: true connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set smtp com information" inspur.sm.edit_smtp_com: status: "disable" provider: "{{ ism }}" - name: "Set smtp com information" inspur.sm.edit_smtp_com: status: "enable" server_ip: "100.2.2.2" email: "[email protected]" server_auth: "enable" server_username: "admin" server_password: "1234qwer!@#$" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_ad_group – Set active directory group information. inspur.sm.edit\_ad\_group – Set active directory group information. =================================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_ad_group`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.ad\_group](ad_group_module#ansible-collections-inspur-sm-ad-group-module) module. Alternative Use [inspur.sm.ad\_group](ad_group_module#ansible-collections-inspur-sm-ad-group-module) instead. Synopsis -------- * Set active directory group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| domain string \| \| Group domain. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| id string / required \| Choices:* 1 * 2 * 3 * 4 * 5 \| Group id. \| \| kvm string \| Choices:* enable * disable \| Kvm privilege. \| \| name string \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| pri string \| Choices:* administrator * user * operator * oem * none \| Group privilege. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| vm string \| Choices:* enable * disable \| Vmedia privilege. \| Examples -------- ``` - name: Ad group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Edit active directory group information" inspur.sm.edit_ad_group: id: "1" name: "wbs" domain: "inspur.com" pri: "administrator" kvm: "enable" vm: "disable" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.update_cpld – Update CPLD. inspur.sm.update\_cpld – Update CPLD. ===================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.update_cpld`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Update CPLD on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| file\_url string \| \| CPLD image file path. Required when list=False. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| id integer \| \| CPLD id. Required when list=False. Only the M5 model supports this parameter. \| \| list boolean \| Choices:* no ← * yes \| Get cpld list. Only the M5 model supports this parameter. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: CPLD test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get cpld list" inspur.sm.update_cpld: list: True provider: "{{ ism }}" - name: "Update cpld" update_cpld: id: 1 file_url: "home/wbs/raw.bin" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.ntp_info – Get NTP information. inspur.sm.ntp\_info – Get NTP information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.ntp_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get NTP information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: NTP test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get ntp information" inspur.sm.ntp_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_ldap – Set ldap information. inspur.sm.edit\_ldap – Set ldap information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_ldap`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set ldap information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| address string \| \| Server Address. \| \| attr string \| Choices:* cn * uid \| Attribute of User Login. \| \| base string \| \| Search Base, Search base is a string of 4 to 64 alpha-numeric characters; It must start with an alphabetical character; Special Symbols like dot(.), comma(,), hyphen(-), underscore(\_), equal-to(=) are allowed. \| \| ca string \| \| CA certificate file path. Required when encry=StartTLS. \| \| ce string \| \| Certificate file path. Required when encry=StartTLS. \| \| cn string \| Choices:* ip * fqdn \| Common name type. Required when encry=StartTLS. \| \| code string \| \| Password. Required when enable=enable. \| \| dn string \| \| Bind DN. Bind DN is a string of 4 to 64 alpha-numeric characters; It must start with an alphabetical character; Special Symbols like dot(.), comma(,), hyphen(-), underscore(\_), equal-to(=) are allowed. \| \| enable string \| Choices:* enable * disable \| LDAP/E-Directory Authentication Status. \| \| encry string \| Choices:* no * SSL * StartTLS \| Encryption Type. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| pk string \| \| Private Key file path. Required when encry=StartTLS. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| server\_port integer \| \| Server Port. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Ldap test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set ldap information" inspur.sm.edit_ldap: enable: "disable" provider: "{{ ism }}" - name: "Set ldap information" inspur.sm.edit_ldap: enable: "enable" encry: "SSL" address: "100.2.2.2" server_port: 389 dn: "cn=manager,ou=login,dc=domain,dc=com" code: "123456" base: "cn=manager" attr: "uid" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.ad_info – Get active directory information. inspur.sm.ad\_info – Get active directory information. ====================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.ad_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get active directory information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Ad test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get active directory information" inspur.sm.ad_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.hard_disk_info – Get hard disk information. inspur.sm.hard\_disk\_info – Get hard disk information. ======================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.hard_disk_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get hard disk information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Hard disk test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get hard disk information" inspur.sm.hard_disk_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.add_user_group – Create user group. inspur.sm.add\_user\_group – Create user group. =============================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.add_user_group`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.user\_group](user_group_module#ansible-collections-inspur-sm-user-group-module) module. Alternative Use [inspur.sm.user\_group](user_group_module#ansible-collections-inspur-sm-user-group-module) instead. Synopsis -------- * Create user group on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| name string / required \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| pri string / required \| Choices:* administrator * operator * user * oem * none \| Group privilege. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Add user group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Add user group" inspur.sm.add_user_group: name: "test" pri: "administrator" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_ntp – Set NTP. inspur.sm.edit\_ntp – Set NTP. ============================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_ntp`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set NTP on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auto\_date string \| Choices:* enable * disable \| Date auto synchronize. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| max\_variety integer \| \| NTP Maximum jump time(minute),max variety(1-60). Only the M6 model supports this parameter. \| \| ntp\_time string \| \| NTP time(YYYYmmddHHMMSS). Only the M5 model supports this parameter. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| server1 string \| \| NTP Server1(ipv4 or ipv6 or domain name), set when auto\_dateis enable. \| \| server2 string \| \| NTP Server2(ipv4 or ipv6 or domain name), set when auto\_date is enable. \| \| server3 string \| \| NTP Server3(ipv4 or ipv6 or domain name), set when auto\_date is enable. \| \| server4 string \| \| NTP Server1(ipv4 or ipv6 or domain name), set when auto\_dateis enable. \| \| server5 string \| \| NTP Server2(ipv4 or ipv6 or domain name), set when auto\_date is enable. \| \| server6 string \| \| NTP Server3(ipv4 or ipv6 or domain name), set when auto\_date is enable. \| \| syn\_cycle integer \| \| NTP syn cycle(minute),sync cycle(5-1440). \| \| time\_zone string \| \| UTC time zone,chose from {-12, -11.5, -11, ... ,11,11.5,12}. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: NTP test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set ntp" inspur.sm.edit_ntp: auto_date: "enable" server2: "time.nist.gov" provider: "{{ ism }}" - name: "Set ntp" inspur.sm.edit_ntp: auto_date: "disable" ntp_time: "20200609083600" provider: "{{ ism }}" - name: "set ntp" inspur.sm.edit_ntp: time_zone: 8 provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_media_instance – Set Virtual Media Instance inspur.sm.edit\_media\_instance – Set Virtual Media Instance ============================================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_media_instance`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set Virtual Media Instance on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| kvm\_num\_cd integer \| Choices:* 0 * 1 * 2 * 3 * 4 \| Select the number of Remote KVM CD/DVD devices that support for virtual Media redirection, The max support number of html5 KVM is 2 and java KVM is 4. \| \| kvm\_num\_fd integer \| Choices:* 0 * 1 * 2 * 3 * 4 \| Select the number of Remote KVM floppy devices that support for Virtual Media redirection. \| \| kvm\_num\_hd integer \| Choices:* 0 * 1 * 2 * 3 * 4 \| Select the number of Remote KVM Hard disk devices to support for Virtual Media redirection. \| \| num\_cd integer \| Choices:* 0 * 1 * 2 * 3 * 4 \| Select the number of CD/DVD devices that support for Virtual Media redirection. \| \| num\_fd integer \| Choices:* 0 * 1 * 2 * 3 * 4 \| Select the number of floppy devices that support for Virtual Media redirection. \| \| num\_hd integer \| Choices:* 0 * 1 * 2 * 3 * 4 \| Select the number of harddisk devices that support for Virtual Media redirection. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| power\_save\_mode string \| Choices:* Enable * Disable \| Check this option to enable Power Save Mode in BMC. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| sd\_media string \| Choices:* Enable * Disable \| Check this option to enable SD Media support in BMC. \| \| secure\_channel string \| Choices:* Enable * Disable \| Check this option to enable encrypt media recirection packets. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Media instance test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set media instance" inspur.sm.edit_media_instance: num_fd: 1 num_cd: 1 num_hd: 1 kvm_num_fd: 1 kvm_num_cd: 1 kvm_num_hd: 1 sd_media: "Enable" secure_channel: "Enable" power_save_mode: "Enable" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.del_session – Delete session. inspur.sm.del\_session – Delete session. ======================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.del_session`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Delete session on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| sid string / required \| \| Session Id , input "all" to delete all sessions. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Delete session test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Delete session" inspur.sm.del_session: sid: "223" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.network_info – Get network information. inspur.sm.network\_info – Get network information. ================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.network_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get netowrk information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Network test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get network information" inspur.sm.network_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.boot_option_info – Get BIOS boot options. inspur.sm.boot\_option\_info – Get BIOS boot options. ===================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.boot_option_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get BIOS boot options on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Boot test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get bios boot option" inspur.sm.boot_option_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.backplane_info – Get disk backplane information. inspur.sm.backplane\_info – Get disk backplane information. =========================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.backplane_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get disk backplane information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Disk backplane test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get backplane information" inspur.sm.backplane_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.update_fw – Update firmware. inspur.sm.update\_fw – Update firmware. ======================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.update_fw`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Update firmware on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| dual\_image string \| Choices:* single * dual ← \| (M5)update dual image(default) or not. Only the M5 model supports this parameter. \| \| has\_me integer \| Choices:* 0 * 1 Default:1 \| (M5-BIOS)update me or not when update bios,only work in INTEL platform,0-no,1-yes. Only the M5 model supports this parameter. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| mode string \| Choices:* Auto ← * Manual \| (BMC)active mode, Manual or Auto(default). \| \| over\_ride integer \| Choices:* 0 * 1 Default:0 \| Reserve Configrations,0-reserve, 1-override. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| type string \| Choices:* BMC * BIOS \| Firmware type. \| \| url string / required \| \| Firmware image url. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Update fw test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "update bios" inspur.sm.update_fw: url: "/home/wbs/SA5112M5_BIOS_4.1.8_Standard_20200117.bin" type: "BIOS" provider: "{{ ism }}" - name: "update bmc" inspur.sm.update_fw: url: "/home/wbs/SA5112M5_BMC_4.17.7_Standard_20200430" mode: "Auto" type: "BMC" dual_image: "dual" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_pdisk – Set physical disk. inspur.sm.edit\_pdisk – Set physical disk. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_pdisk`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set physical disk on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| ctrl\_id integer \| \| Raid controller ID. Required when Info=None. \| \| device\_id integer \| \| physical drive id. Required when Info=None. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| info string \| Choices:* show \| Show controller and pdisk info. \| \| option string \| Choices:* UG * UB * OFF * FAIL * RBD * ON * JB * ES * EM * EN * ET * LOC * STL \| Set operation options fo physical disk, UG is Unconfigured Good,UB is Unconfigured Bad, OFF is offline,FAIL is Failed,RBD is Rebuild, ON is Online,JB is JBOD,ES is Drive Erase stop, EM is Drive Erase Simple,EN is Drive Erase Normal, ET is Drive Erase Through,LOC is Locate,STL is Stop Locate. Required when Info=None. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Edit pdisk test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Show pdisk information" inspur.sm.edit_pdisk: info: "show" provider: "{{ ism }}" - name: "Edit pdisk" inspur.sm.edit_pdisk: ctrl_id: 0 device_id: 1 option: "LOC" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_ad – Set active directory information. inspur.sm.edit\_ad – Set active directory information. ====================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_ad`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set active directory information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| addr1 string \| \| Domain Controller Server Address1. \| \| addr2 string \| \| Domain Controller Server Address2. \| \| addr3 string \| \| Domain Controller Server Address3. \| \| code string \| \| Secret Password. \| \| domain string \| \| User Domain Name. \| \| enable string \| Choices:* enable * disable \| Active Directory Authentication Status. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| name string \| \| Secret Username. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| timeout integer \| \| The Time Out configuration(15-300). \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Ad test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set active directory information" inspur.sm.edit_ad: enable: "disable" provider: "{{ ism }}" - name: "Set active directory information" inspur.sm.edit_ad: enable: "enable" name: "inspur" code: "123456" timeout: 120 domain: "inspur.com" addr1: "100.2.2.2" addr2: "100.2.2.3" addr3: "100.2.2.4" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.edit_power_budget – Set power budget information. inspur.sm.edit\_power\_budget – Set power budget information. ============================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_power_budget`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set power budget information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| action string \| Choices:* add * delete * open * close \| Type to action. Required when range=False. \| \| end1 integer \| \| Pause period of add, end time,must be greater than start time,from 0 to 24. \| \| end2 integer \| \| Pause period of add, end time,must be greater than start time,from 0 to 24. \| \| end3 integer \| \| Pause period of add, end time,must be greater than start time,from 0 to 24. \| \| end4 integer \| \| Pause period of add, end time,must be greater than start time,from 0 to 24. \| \| end5 integer \| \| Pause period of add, end time,must be greater than start time,from 0 to 24. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| id integer \| Choices:* 1 * 2 * 3 * 4 \| Policy id. Required when range=False. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| range boolean \| Choices:* no ← * yes \| Range of power budget watts. \| \| start1 integer \| \| Pause period of add, start time, from 0 to 24. \| \| start2 integer \| \| Pause period of add, start time, from 0 to 24. \| \| start3 integer \| \| Pause period of add, start time, from 0 to 24. \| \| start4 integer \| \| Pause period of add, start time, from 0 to 24. \| \| start5 integer \| \| Period of add, start time, from 0 to 24. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| watts integer \| \| Power budget watts of add. Required when action=add. \| \| week1 list / elements=string \| \| Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri. \| \| week2 list / elements=string \| \| Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri. \| \| week3 list / elements=string \| \| Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri. \| \| week4 list / elements=string \| \| Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri. \| \| week5 list / elements=string \| \| Pause period of add,repetition period,the input parameters are 'Mon','Tue','Wed','Thur','Fri','Sat','Sun',separated by commas,such as Mon,Wed,Fri. \| Examples -------- ``` - name: Power budget test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get power budget range" inspur.sm.edit_power_budget: range: True provider: "{{ ism }}" - name: "add power budget" inspur.sm.edit_power_budget: action: "add" id: 1 watts: 1500 start1: 2 end1: 5 week1: - Mon - Wed - Fri provider: "{{ ism }}" - name: "Set power budget status to open" inspur.sm.edit_power_budget: action: "open" id: 1 provider: "{{ ism }}" - name: "Set power budget status to close" inspur.sm.edit_power_budget: action: "close" id: 1 provider: "{{ ism }}" - name: "Delete power budget" inspur.sm.edit_power_budget: action: "delete" id: 1 provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.system_log_info – Get BMC system log information. inspur.sm.system\_log\_info – Get BMC system log information. ============================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.system_log_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get BMC system log information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| count integer \| \| Get the most recent log of a specified number. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| level string \| Choices:* alert ← * critical * error * notice * warning * debug * emergency * info \| Log level. \| \| log\_time string \| \| Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| system\_file string \| \| Store logs to a file. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Bmc system log info test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get bmc system log information" inspur.sm.system_log_info: level: "alert" log_time: "2020-06-01T12:30+08:00" provider: "{{ ism }}" - name: "Get bmc system log information" inspur.sm.system_log_info: count: 30 provider: "{{ ism }}" - name: "Get bmc system log information" inspur.sm.system_log_info: system_file: "/home/wbs/wbs.log" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.bios_export – Export BIOS config. inspur.sm.bios\_export – Export BIOS config. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.bios_export`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Export BIOS config on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| file\_url string / required \| \| Suffix is .json/.conf, FILEURI format,"/directory/filename". \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Bios test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Export bios config" inspur.sm.bios_export: file_url: "/home/wbs/bios.conf" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.pdisk_info – Get physical disks information. inspur.sm.pdisk\_info – Get physical disks information. ======================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.pdisk_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get physical disks information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Pdisk test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get physical disks information" inspur.sm.pdisk_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.add_user – Create user. inspur.sm.add\_user – Create user. ================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.add_user`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.user](user_module#ansible-collections-inspur-sm-user-module) module. Alternative Use [inspur.sm.user](user_module#ansible-collections-inspur-sm-user-module) instead. Synopsis -------- * Create user on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| priv list / elements=string / required \| Choices:* kvm * vmm * sol * none \| User access, select one or more from None/KVM/VMM/SOL. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| role\_id string / required \| \| user group, default user group,'Administrator', 'Operator', 'Commonuser','OEM','NoAccess', use command `user_group_info` can get all group information. \| \| uname string / required \| \| User name of new user. \| \| upass string / required \| \| User password of new user. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Add user test hosts: ism no_log: true connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Add user" inspur.sm.add_user: uname: "wbs" upass: my_password role_id: "Administrator" priv: "kvm,sol" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.mem_info – Get memory information. inspur.sm.mem\_info – Get memory information. ============================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.mem_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get memory information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Memory test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get memory information" inspur.sm.mem_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.clear_event_log – Clear event log. inspur.sm.clear\_event\_log – Clear event log. ============================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.clear_event_log`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Clear event log on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Clear event log test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Clear event log" inspur.sm.clear_event_log: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.reset_kvm – KVM reset. inspur.sm.reset\_kvm – KVM reset. ================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.reset_kvm`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * KVM reset on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Reset kvm test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Reset kvm" inspur.sm.reset_kvm: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.server_info – Get server status information. inspur.sm.server\_info – Get server status information. ======================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.server_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get server status information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Server test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get server status information" inspur.sm.server_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.ldap_group_info – Get ldap group information. inspur.sm.ldap\_group\_info – Get ldap group information. ========================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.ldap_group_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get ldap group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Ldap group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get ldap group information" inspur.sm.ldap_group_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.adapter_info – Get adapter information. inspur.sm.adapter\_info – Get adapter information. ================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.adapter_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get adapter information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Adapter test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get adapter information" inspur.sm.adapter_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.ad_group_info – Get active directory group information. inspur.sm.ad\_group\_info – Get active directory group information. =================================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.ad_group_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get active directory group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Ad group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get active directory group information" inspur.sm.ad_group_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.edit_auto_capture – Set auto capture screen. inspur.sm.edit\_auto\_capture – Set auto capture screen. ======================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_auto_capture`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set auto capture screen on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| status string / required \| Choices:* enable * disable \| Capture status. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Screen test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set auto capture screen" inspur.sm.edit_auto_capture: status: "enable" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.user_group – Manage user group. inspur.sm.user\_group – Manage user group. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.user_group`. New in version 1.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage user group on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| name string / required \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| pri string \| Choices:* administrator * operator * user * oem * none \| Group privilege. Required when state=present. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| state string \| Choices:* present ← * absent \| Whether the user group should exist or not, taking action if the state is different from what is stated. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: User group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Add user group" inspur.sm.user_group: state: "present" name: "test" pri: "administrator" provider: "{{ ism }}" - name: "Set user group" inspur.sm.user_group: state: "present" name: "test" pri: "user" provider: "{{ ism }}" - name: "Delete user group" inspur.sm.user_group: state: "absent" name: "test" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_connect_media – Start/Stop virtual media Image inspur.sm.edit\_connect\_media – Start/Stop virtual media Image =============================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_connect_media`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Start/Stop virtual media Image on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| image\_name string / required \| \| Image name. \| \| image\_type string / required \| Choices:* CD * FD * HD \| Virtual media type. Only the M5 model supports this parameter. \| \| op\_type string / required \| Choices:* start * stop \| Start or stop media. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Connect media test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set remote image redirection" inspur.sm.edit_connect_media: image_type: "CD" op_type: "start" image_name: "aa.iso" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.download_manual_screenshot – Download manual screenshots. inspur.sm.download\_manual\_screenshot – Download manual screenshots. ===================================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.download_manual_screenshot`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Download manual screenshots on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| file\_url string / required \| \| Screen capture file path. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Screen test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Download manual screenshots" inspur.sm.download_manual_screenshot: file_url: "/home/wbs/screen" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.del_ad_group – Delete active directory group information. inspur.sm.del\_ad\_group – Delete active directory group information. ===================================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.del_ad_group`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.ad\_group](ad_group_module#ansible-collections-inspur-sm-ad-group-module) module. Alternative Use [inspur.sm.ad\_group](ad_group_module#ansible-collections-inspur-sm-ad-group-module) instead. Synopsis -------- * Delete active directory group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| name string / required \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Ad group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Delete active directory group information" inspur.sm.del_ad_group: name: "inspur" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_psu_config – Set psu config information. inspur.sm.edit\_psu\_config – Set psu config information. ========================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_psu_config`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set psu config information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| id integer / required \| \| Power id. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| switch string / required \| Choices:* active * standby * normal \| Power supply mode, active or standby. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Psu config test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set psu config information" inspur.sm.edit_psu_config: id: 1 switch: "active" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.network_link_info – Get network link information. inspur.sm.network\_link\_info – Get network link information. ============================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.network_link_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get network link information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: link test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get network link information" inspur.sm.network_link_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.del_ldap_group – Delete ldap group information. inspur.sm.del\_ldap\_group – Delete ldap group information. =========================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.del_ldap_group`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.ldap\_group](ldap_group_module#ansible-collections-inspur-sm-ldap-group-module) module. Alternative Use [inspur.sm.ldap\_group](ldap_group_module#ansible-collections-inspur-sm-ldap-group-module) instead. Synopsis -------- * Delete ldap group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| name string / required \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Ldap group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Delete ldap group information" inspur.sm.del_ldap_group: name: "inspur" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_vlan – Set vlan information. inspur.sm.edit\_vlan – Set vlan information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_vlan`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set vlan information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| interface\_name string / required \| Choices:* eth0 * eth1 * bond0 \| Set interface\_name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| vlan\_id integer \| \| The Identification for VLAN configuration(2-4094). \| \| vlan\_priority integer \| \| The priority for VLAN configuration(1-7). \| \| vlan\_status string \| Choices:* enable * disable \| Enable or disable vlan. \| Examples -------- ``` - name: Vlan test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set vlan information" inspur.sm.edit_vlan: interface_name: "eth0" vlan_status: "disable" provider: "{{ ism }}" - name: "Set vlan information" inspur.sm.edit_vlan: interface_name: "eth0" vlan_status: "enable" vlan_id: 2 vlan_priority: 1 provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.connect_media_info – Get remote images redirection information. inspur.sm.connect\_media\_info – Get remote images redirection information. =========================================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.connect_media_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get remote images redirection information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Connect media test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get remote images redirection information" inspur.sm.connect_media_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.self_test_info – Get self test information. inspur.sm.self\_test\_info – Get self test information. ======================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.self_test_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get self test information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: self test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get self test information" inspur.sm.self_test_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_ldap_group – Set ldap group information. inspur.sm.edit\_ldap\_group – Set ldap group information. ========================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_ldap_group`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.ldap\_group](ldap_group_module#ansible-collections-inspur-sm-ldap-group-module) module. Alternative Use [inspur.sm.ldap\_group](ldap_group_module#ansible-collections-inspur-sm-ldap-group-module) instead. Synopsis -------- * Set ldap group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| base string \| \| Search Base Search base is a string of 4 to 64 alpha-numeric characters; It must start with an alphabetical character; Special Symbols like dot(.), comma(,), hyphen(-), underscore(\_), equal-to(=) are allowed. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| id string / required \| Choices:* 1 * 2 * 3 * 4 * 5 \| Group id. \| \| kvm string \| Choices:* enable * disable \| Kvm privilege. \| \| name string \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| pri string \| Choices:* administrator * user * operator * oem * none \| Group privilege. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| vm string \| Choices:* enable * disable \| Vmedia privilege. \| Examples -------- ``` - name: Ldap group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Edit ldap group information" inspur.sm.edit_ldap_group: id: "1" name: "wbs" base: "cn=manager" pri: "administrator" kvm: "enable" vm: "disable" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.smtp_info – Get SMTP information. inspur.sm.smtp\_info – Get SMTP information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.smtp_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get SMTP information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Smtp test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get smtp information" inspur.sm.smtp_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.pcie_info – Get PCIE information. inspur.sm.pcie\_info – Get PCIE information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.pcie_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get PCIE information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: PCIE test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get PCIE information" inspur.sm.pcie_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.bios_import – Import BIOS config. inspur.sm.bios\_import – Import BIOS config. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.bios_import`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Import BIOS config on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| file\_url string / required \| \| Suffix is .json/.conf, FILEURI format,"/directory/filename". \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Bios test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Import bios config" inspur.sm.bios_import: file_url: "/home/wbs/bios.conf" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_manual_capture – Set manual capture screen. inspur.sm.edit\_manual\_capture – Set manual capture screen. ============================================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_manual_capture`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set manual capture screen on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| type string / required \| Choices:* capture * delete \| Manual type. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Screen test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set manual capture screen" inspur.sm.edit_manual_capture: type: "capture" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_kvm – Set KVM. inspur.sm.edit\_kvm – Set KVM. ============================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_kvm`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set KVM on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| automatic\_off string \| Choices:* enable * disable \| Automatically OFF Server Monitor, When KVM Launches. \| \| client\_type string \| Choices:* vnc * viewer \| Client Type. Only the M6 model supports this parameter. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| keyboard\_language string \| Choices:* AD * DA * NL-BE * NL-NL * GB * US * FI * FR-BE * FR * DE * DE-CH * IT * JP * ON * PT * EC * SV * TR\_F * TR\_Q \| Select the Keyboard Language. AD is Auto Detect, DA is Danish, NL-BE is Dutch Belgium, NL-NL is Dutch Netherland, GB is English UK ,US is English US, FI is Finnish, FR-BE is French Belgium, FR is French France, DE is German Germany, DE-CH is German Switzerland, IT is Italian, JP is Japanese, NO is Norwegian, PT is Portuguese, ES is Spanish, SV is Swedish, TR\_F is Turkish F, TR\_Q is Turkish Q. \| \| kvm\_encryption string \| Choices:* enable * disable \| Encrypt KVM packets. \| \| local\_monitor\_off string \| Choices:* enable * disable \| Server Monitor OFF Feature Status. \| \| media\_attach string \| Choices:* attach * auto \| Two types of VM attach mode are available. Attach is Immediately attaches Virtual Media to the server upon bootup. Auto is Attaches Virtual Media to the server only when a virtual media session is started. \| \| non\_secure string \| Choices:* enable * disable \| Enable/disable Non Secure Connection Type. Only the M6 model supports this parameter. Required when client\_type=vnc. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| retry\_count integer \| \| Number of times to be retried in case a KVM failure occurs.Retry count ranges from 1 to 20. \| \| retry\_time\_interval integer \| \| The Identification for retry time interval configuration (5-30) seconds. \| \| ssh\_vnc string \| Choices:* enable * disable \| Enable/disable VNC over SSH in BMC. Only the M6 model supports this parameter. Required when client\_type=vnc. \| \| stunnel\_vnc string \| Choices:* enable * disable \| Enable/disable VNC over Stunnel in BMC. Only the M6 model supports this parameter. Required when client\_type=vnc. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: KVM test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set KVM" inspur.sm.edit_kvm: kvm_encryption: "enable" media_attach: "auto" keyboard_language: "AD" retry_count: 13 retry_time_interval: 10 local_monitor_off: "enable" automatic_off: "enable" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_dns – Set dns information. inspur.sm.edit\_dns – Set dns information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_dns`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set dns information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| dns\_iface string \| \| DNS Interface,input like 'eth0', 'eth1', 'bond0'. Required when dns\_manual=auto. \| \| dns\_manual string \| Choices:* manual * auto \| DNS Settings. \| \| dns\_priority string \| Choices:* 4 * 6 \| IP Priority. Required when dns\_manual=auto. \| \| dns\_server1 string \| \| DNS Server1 IPv4 or IPv6 address. Required when dns\_manual=manual. \| \| dns\_server2 string \| \| DNS Server2 IPv4 or IPv6 address. Required when dns\_manual=manual. \| \| dns\_server3 string \| \| DNS Server3 IPv4 or IPv6 address. Required when dns\_manual=manual. \| \| dns\_status string \| Choices:* enable * disable \| DNS status. \| \| domain\_iface string \| \| Network Interface,input like 'eth0\_v4', 'eth0\_v6', 'eth1\_v4', 'eth1\_v6', 'bond0\_v4', 'bond0\_v6'. Required when domain\_manual=auto. \| \| domain\_manual string \| Choices:* manual * auto \| Domain Settings. \| \| domain\_name string \| \| Domain Name. Required when domain\_manual=manual. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| host\_cfg string \| Choices:* manual * auto \| Host Settings. \| \| host\_name string \| \| Host Name. Required when host\_cfg=manual. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: DNS test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set dns information" inspur.sm.edit_dns: dns_status: "disable" provider: "{{ ism }}" - name: "Set dns information" inspur.sm.edit_dns: dns_status: "enable" host_cfg: "manual" host_name: "123456789" domain_manual: "auto" domain_iface: "eth0_v4" dns_manual: "manual" dns_server1: "100.2.2.2" dns_server2: "100.2.2.3" dns_server3: "100.2.2.4" provider: "{{ ism }}" - name: "Set dns information" inspur.sm.edit_dns: dns_status: "enable" host_cfg: "manual" host_name: "123456789" domain_manual: "manual" domain_name: "inspur.com" dns_manual: "auto" dns_iface: "eth0" dns_priority: "4" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.edit_service – Set service settings. inspur.sm.edit\_service – Set service settings. =============================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_service`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set service settings on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| interface string \| Choices:* eth0 * eth1 * both * bond0 \| It shows the interface in which service is running. The user can choose any one of the available interfaces. Only the M5 model supports this parameter. \| \| non\_secure\_port integer \| \| Used to configure non secure port number for the service. Port value ranges from 1 to 65535. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| secure\_port integer \| \| Used to configure secure port number for the service. Port value ranges from 1 to 65535. \| \| service\_name string / required \| Choices:* web * kvm * cd-media * fd-media * hd-media * ssh * telnet * solssh * snmp * vnc \| Displays service name of the selected slot(readonly). The vnc option is not supported in M5. The fd-media/telnet/snmp option is not supported in M6. \| \| state string \| Choices:* active * inactive \| Displays the current status of the service, either active or inactive state. Check this option to start the inactive service. \| \| timeout integer \| \| Displays the session timeout value of the service. For web, SSH and telnet service, user can configure the session timeout value. Web timeout value ranges from 300 to 1800 seconds. SSH and Telnet timeout value ranges from 60 to 1800 seconds. timeout value should be in multiples of 60 seconds. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Edit service test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Edit kvm" inspur.sm.edit_service: service_name: "kvm" state: "active" timeout: "1200" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.power_budget_info – Get power budget information. inspur.sm.power\_budget\_info – Get power budget information. ============================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.power_budget_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get power budget information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Power budget test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get power budget information" inspur.sm.power_budget_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.clear_audit_log – Clear BMC audit log. inspur.sm.clear\_audit\_log – Clear BMC audit log. ================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.clear_audit_log`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Clear BMC audit log on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Clear BMC audit log test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Clear BMC audit log " inspur.sm.clear_audit_log: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.preserve_config_info – Get preserve config information. inspur.sm.preserve\_config\_info – Get preserve config information. =================================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.preserve_config_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get preserve config information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: preserve test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get preserve config information" inspur.sm.preserve_config_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_power_status – Set power status information. inspur.sm.edit\_power\_status – Set power status information. ============================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_power_status`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set power status information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| state string / required \| Choices:* On * ForceOff * ForcePowerCycle * ForceReset * GracefulShutdown \| Power status. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Power status test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set power status information" inspur.sm.edit_power_status: state: "On" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.gpu_info – Get GPU information. inspur.sm.gpu\_info – Get GPU information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.gpu_info`. New in version 1.2.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get GPU information on Inspur server. * Only the M6 models support this feature. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: GPU test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get gpu information" inspur.sm.gpu_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.network_bond_info – Get network bond information. inspur.sm.network\_bond\_info – Get network bond information. ============================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.network_bond_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get network bond information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: bond test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get network bond information" inspur.sm.network_bond_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.service_info – Get service information. inspur.sm.service\_info – Get service information. ================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.service_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get service information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Service info test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get service information" inspur.sm.service_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.temp_info – Get temp information. inspur.sm.temp\_info – Get temp information. ============================================ Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.temp_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get temp information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Temp test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get temp information" inspur.sm.temp_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_network_link – Set network link. inspur.sm.edit\_network\_link – Set network link. ================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_network_link`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set network link on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| auto\_nego string \| Choices:* enable * disable \| This option is enabled to allow the device to perform automatic configuration to achieve the best possible mode of operation(speed and duplex) over a link. \| \| duplex\_mode string \| Choices:* HALF * FULL \| Select any one of the following Duplex Mode. Required when auto\_nego=disable. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| interface string / required \| Choices:* shared * dedicated * both \| Interface name. \| \| link\_speed integer \| Choices:* 10 * 100 \| Link speed will list all the supported capabilities of the network interface. It can be 10/100 Mbps. Required when auto\_nego=disable. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: link test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set network link" inspur.sm.edit_network_link: interface: "dedicated" auto_nego: "enable" provider: "{{ ism }}" - name: "Set network link" inspur.sm.edit_network_link: interface: "dedicated" auto_nego: "disable" link_speed: 100 duplex_mode: "FULL" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_virtual_media – Set virtual media. inspur.sm.edit\_virtual\_media – Set virtual media. =================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_virtual_media`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set virtual media on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| local\_media\_support string \| Choices:* Enable * Disable \| To enable or disable Local Media Support,check or uncheck the checkbox respectively. Only the M5 model supports this parameter. \| \| mount string \| Choices:* Enable * Disable \| Whether to mount virtual media. \| \| mount\_type string \| Choices:* CD * FD * HD \| Virtual mount type. The FD option is not supported in M6. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| remote\_domain\_name string \| \| Remote Domain Name,Domain Name field is optional. \| \| remote\_media\_support string \| Choices:* Enable * Disable \| To enable or disable Remote Media support,check or uncheck the checbox respectively. \| \| remote\_password string \| \| Remote Password. Required when remote\_share\_type=cifs. \| \| remote\_server\_address string \| \| Address of the server where the remote media images are stored. \| \| remote\_share\_type string \| Choices:* nfs * cifs \| Share Type of the remote media server either NFS or Samba(CIFS). \| \| remote\_source\_path string \| \| Source path to the remote media images.. \| \| remote\_user\_name string \| \| Remote User Name. Required when remote\_share\_type=cifs. \| \| same\_settings integer \| Choices:* 0 * 1 \| Same settings with CD,0 is No,1 is Yes. Required when mount\_type=0. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Media test hosts: ism no_log: true connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set local media" inspur.sm.edit_virtual_media: local_media_support: "Enable" provider: "{{ ism }}" - name: "Set remote media" inspur.sm.edit_virtual_media: remote_media_support: "Enable" mount_type: 0 same_settings: 0 mount: "Enable" remote_server_address: "100.2.28.203" remote_source_path: "/data/nfs/server/" remote_share_type: "nfs" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.event_log_info – Get event log information. inspur.sm.event\_log\_info – Get event log information. ======================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.event_log_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get event log information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| count integer \| \| Get the most recent log of a specified number. \| \| event\_file string \| \| Store logs to a file. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| log\_time string \| \| Get logs after the specified date, time should be YYYY-MM-DDTHH:MM+HH:MM, like 2019-06-27T12:30+08:00. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Event log info test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get event log information" inspur.sm.event_log_info: log_time: "2020-06-01T12:30+08:00" provider: "{{ ism }}" - name: "Get event log information" inspur.sm.event_log_info: count: 30 provider: "{{ ism }}" - name: "Get event log information" inspur.sm.event_log_info: event_file: "/home/wbs/wbs.log" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.collect_blackbox – Collect blackbox log. inspur.sm.collect\_blackbox – Collect blackbox log. =================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.collect_blackbox`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Collect blackbox log on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| file\_url string / required \| \| File download path. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Collect blackbox test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Collect blackbox log" inspur.sm.collect_blackbox: file_url: "/home/wbs/wbs.log" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.auto_capture_info – Get auto capture screen information. inspur.sm.auto\_capture\_info – Get auto capture screen information. ==================================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.auto_capture_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get auto capture screen information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Screen test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get auto capture screen information" inspur.sm.auto_capture_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.del_user_group – Delete user group. inspur.sm.del\_user\_group – Delete user group. =============================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.del_user_group`. New in version 0.1.0: of inspur.sm * [DEPRECATED](#deprecated) * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) * [Status](#status) DEPRECATED ---------- Removed in version 3.0.0 Why Merge functions into the [inspur.sm.user\_group](user_group_module#ansible-collections-inspur-sm-user-group-module) module. Alternative Use [inspur.sm.user\_group](user_group_module#ansible-collections-inspur-sm-user-group-module) instead. Synopsis -------- * Delete user group on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| name string / required \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Delete user group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Delete user group" inspur.sm.del_user_group: name: "test" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| Status ------ * This module will be removed in version 3.0.0. [deprecated] * For more information see [DEPRECATED](#deprecated). ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.edit_boot_option – Set BIOS boot options. inspur.sm.edit\_boot\_option – Set BIOS boot options. ===================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_boot_option`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set BIOS boot options on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| device string \| Choices:* none * HDD * PXE * CD * BIOSSETUP \| Boot device. \| \| effective string \| Choices:* Once * Continuous \| Effective, once or continuous. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| mode string \| Choices:* Legacy * UEFI \| Boot type. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Boot test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set bios boot option" inspur.sm.edit_boot_option: device: "PXE" effective: "Once" mode: "Legacy" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.uid_info – Get UID information. inspur.sm.uid\_info – Get UID information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.uid_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get UID information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: UID test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get UID information" inspur.sm.uid_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.psu_info – Get psu information. inspur.sm.psu\_info – Get psu information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.psu_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get psu information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Psu test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get psu information" inspur.sm.psu_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs
ansible inspur.sm.edit_power_restore – Set power restore information. inspur.sm.edit\_power\_restore – Set power restore information. =============================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.edit_power_restore`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Set power restore information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| option string / required \| Choices:* on * off * restore \| Set power policy option. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Power restore test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Set power restore information" inspur.sm.edit_power_restore: option: "on" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.download_auto_screenshot – Download auto screenshots. inspur.sm.download\_auto\_screenshot – Download auto screenshots. ================================================================= Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.download_auto_screenshot`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Download auto screenshots on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| file\_url string / required \| \| Screen capture file path. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Screen test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Download auto screenshots" inspur.sm.download_auto_screenshot: file_url: "/home/wbs/screen" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.ldap_group – Manage ldap group information. inspur.sm.ldap\_group – Manage ldap group information. ====================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.ldap_group`. New in version 1.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Manage ldap group information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| base string \| \| Search Base. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| kvm string \| Choices:* enable * disable \| Kvm privilege. \| \| name string / required \| \| Group name. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| pri string \| Choices:* administrator * user * operator * oem * none \| Group privilege. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| state string \| Choices:* present ← * absent \| Whether the ldap group should exist or not, taking action if the state is different from what is stated. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| vm string \| Choices:* enable * disable \| Vmedia privilege. \| Examples -------- ``` - name: Ldap group test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Add ldap group information" inspur.sm.ldap_group: state: "present" name: "wbs" base: "cn=manager" pri: "administrator" kvm: "enable" vm: "disable" provider: "{{ ism }}" - name: "Set ldap group information" inspur.sm.ldap_group: state: "present" name: "wbs" pri: "user" kvm: "disable" provider: "{{ ism }}" - name: "Delete ldap group information" inspur.sm.ldap_group: state: "absent" name: "wbs" provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.kvm_info – Get KVM information. inspur.sm.kvm\_info – Get KVM information. ========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.kvm_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get KVM information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: KVM test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get KVM information" inspur.sm.kvm_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.add_ldisk – Create logical disk. inspur.sm.add\_ldisk – Create logical disk. =========================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.add_ldisk`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Create logical disk on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| access integer \| Choices:* 1 * 2 * 3 \| Access Policy, 1 - Read Write, 2 - Read Only, 3 - Blocked. Required when Info=None. \| \| cache integer \| Choices:* 1 * 2 * 3 \| Drive Cache, 1 - Unchanged, 2 - Enabled,3 - Disabled. Required when Info=None. \| \| ctrl\_id integer \| \| Raid controller ID. Required when Info=None. \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| info string \| Choices:* show \| Show controller and physical drive info. \| \| init integer \| Choices:* 1 * 2 * 3 \| Init State, 1 - No Init, 2 - Quick Init, 3 - Full Init. Required when Info=None. \| \| io integer \| Choices:* 1 * 2 \| IO Policy, 1 - Direct IO, 2 - Cached IO. Required when Info=None. \| \| level integer \| Choices:* 0 * 1 * 5 * 6 * 10 \| RAID Level, 0 - RAID0, 1 - RAID1, 5 - RAID5, 6 - RAID6, 10 - RAID10. Required when Info=None. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| r integer \| Choices:* 1 * 2 \| Read Policy, 1 - Read Ahead, 2 - No Read Ahead. Required when Info=None. \| \| select integer \| \| Select Size, from 1 to 100. Required when Info=None. \| \| size integer \| Choices:* 1 * 2 * 3 * 4 * 5 \| Strip Size, 1 - 64k, 2 - 128k, 3 - 256k, 4 - 512k, 5 - 1024k. Required when Info=None. \| \| slot list / elements=integer \| \| Slot Num,input multiple slotNumber like 0,1,2.... Required when Info=None. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| w integer \| Choices:* 1 * 2 * 3 \| Write Policy, 1 - Write Throgh, 2 - Write Back, 3 - Write caching ok if bad BBU. Required when Info=None. \| Examples -------- ``` - name: Add ldisk test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Show pdisk information" inspur.sm.add_ldisk: info: "show" provider: "{{ ism }}" - name: "Add ldisk" inspur.sm.add_ldisk: ctrl_id: 0 level: 1 size: 1 access: 1 r: 1 w: 1 io: 1 cache: 1 init: 2 select: 10 slot: 0,1 provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group) ansible inspur.sm.fw_version_info – Get firmware version information. inspur.sm.fw\_version\_info – Get firmware version information. =============================================================== Note This plugin is part of the [inspur.sm collection](https://galaxy.ansible.com/inspur/sm) (version 1.3.0). You might already have this collection installed if you are using the `ansible` package. It is not included in `ansible-core`. To check whether it is installed, run `ansible-galaxy collection list`. To install it, use: `ansible-galaxy collection install inspur.sm`. To use it in a playbook, specify: `inspur.sm.fw_version_info`. New in version 0.1.0: of inspur.sm * [Synopsis](#synopsis) * [Parameters](#parameters) * [Examples](#examples) * [Return Values](#return-values) Synopsis -------- * Get firmware version information on Inspur server. Parameters ---------- \| Parameter \| Choices/Defaults \| Comments \| \| --- \| --- \| --- \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| provider dictionary \| \| A dict object containing connection details. \| \| \| host string \| \| Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. \| \| \| password string \| \| Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead. \| \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| \| username string \| \| Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead. \| Examples -------- ``` - name: Firmware version test hosts: ism connection: local gather_facts: no vars: ism: host: "{{ ansible_ssh_host }}" username: "{{ username }}" password: "{{ password }}" tasks: - name: "Get firmware version information" inspur.sm.fw_version_info: provider: "{{ ism }}" ``` Return Values ------------- Common return values are documented [here](../../../reference_appendices/common_return_values#common-return-values), the following are the fields unique to this module: \| Key \| Returned \| Description \| \| --- \| --- \| --- \| \| changed boolean \| always \| Check to see if a change was made on the device. \| \| message string \| always \| Messages returned after module execution. \| \| state string \| always \| Status after module execution. \| ### Authors * WangBaoshan (@ISIB-group)	programming_docs

Subsets and Splits

No saved queries yet

Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.