dellemc / dellemc.powerstore / 3.2.0 / module / file_interface Manage File interface for PowerStore | "added in version" 3.1.0 of dellemc.powerstore" Authors: Trisha Datta (@trisha-dell) <ansible.team@dell.com>dellemc.powerstore.file_interface (3.2.0) — module
Install with ansible-galaxy collection install dellemc.powerstore:==3.2.0
collections: - name: dellemc.powerstore version: 3.2.0
Managing file interfaces on PowerStore Storage System includes creating a file interface, getting details of a file interface, modifying a file interface and deleting a file interface.
- name: Create File interface register: result dellemc.powerstore.file_interface: array_ip: "{{ array_ip }}" validate_certs: "{{ validate_certs }}" user: "{{ user }}" password: "{{ password }}" nas_server: "{{ nas_server_id }}" ip_address: "10.**.**.**" vlan_id: 0 prefix_length: 21 gateway: "10.**.**.1" state: "present"
- name: Get file interface with file_interface_id dellemc.powerstore.file_interface: array_ip: "{{ array_ip }}" validate_certs: "{{ validate_certs }}" user: "{{ user }}" password: "{{ password }}" file_interface_id: "{{ file_interface_id }}"
- name: Get file interface with nas_server_name and ip_addresss dellemc.powerstore.file_interface: array_ip: "{{ array_ip }}" validate_certs: "{{ validate_certs }}" user: "{{ user }}" password: "{{ password }}" nas_server: "sample_nas_server" ip_address: "10.**.**.**"
- name: Modify file interface dellemc.powerstore.file_interface: array_ip: "{{ array_ip }}" validate_certs: "{{ validate_certs }}" user: "{{ user }}" password: "{{ password }}" file_interface_id: "{{ file_interface_id }}" ip_address: "10.**.**.@@" vlan_id: 0 prefix_length: 21 gateway: "10.**.**.1" state: "present"
- name: Delete file interface dellemc.powerstore.file_interface: array_ip: "{{ array_ip }}" validate_certs: "{{ validate_certs }}" user: "{{ user }}" password: "{{ password }}" file_interface_id: "{{ file_interface_id }}" state: "absent"
port: description: - Port number for the PowerStore array. - If not passed, it will take 443 as default. type: int role: choices: - Production - Backup - System description: - C(Production) type of network interface is used for all file protocols and services of a NAS server. This type of interface is inactive while a NAS server is in destination mode. - C(Backup) type of network interface is used only for NDMP/NFS backup or disaster recovery testing. This type of interface is always active in all NAS server modes. - C(System) type of interface are reserved for system traffic such as for NAS server migration, they can not be used for the production traffic. - C(System) type is not supported during create interface. type: str user: description: - The username of the PowerStore host. required: true type: str state: choices: - absent - present default: present description: - Define whether the file interface should exist or not. - For Delete operation only, it should be set to C(absent). type: str gateway: description: - Gateway address for the network interface. - IPv4 and IPv6 are supported. type: str timeout: default: 120 description: - Time after which the connection will get terminated. - It is to be mentioned in seconds. type: int vlan_id: description: - Virtual Local Area Network (VLAN) identifier for the interface. type: int array_ip: description: - IP or FQDN of the PowerStore management system. required: true type: str password: description: - The password of the PowerStore host. required: true type: str ip_address: description: - IP address of the network interface. - IPv4 and IPv6 are supported. type: str ip_port_id: description: - Unique Identifier of the IP Port that is associated with the file interface. type: str nas_server: description: - Unique identifier/name of the NAS server to which the network interface belongs, as defined by the I(nas_server) resource type. type: str is_disabled: description: - Indicates whether the network interface is disabled. type: bool prefix_length: description: - Prefix length for the interface. - IPv4 and IPv6 are supported. type: int validate_certs: aliases: - verifycert default: true description: - Boolean variable to specify whether to validate SSL certificate or not. - C(true) - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate. - C(false) - indicates that the SSL certificate should not be verified. type: bool file_interface_id: description: - The unique identifier of the file interface. type: str is_destination_override_enabled: description: - Used in replication context when the user wants to override the settings on the destination. type: bool
changed: description: Whether or not the resource has changed. returned: always sample: 'false' type: bool file_interface_details: contains: gateway: description: Gateway address for the network interface. type: str id: description: The unique identifier of the file interface. type: str ip_address: description: IP address of the network interface. type: str ip_port_id: description: Unique Identifier of the IP Port that is associated with the file interface. type: str is_destination_override_enabled: description: Used in replication context when the user wants to override the settings on the destination. type: bool is_disabled: description: Indicates whether the network interface is disabled. type: bool name: description: Name of the network interface. This property supports case-insensitive filtering. type: str nas_server_id: description: Unique identifier of the NAS server. type: str prefix_length: description: Prefix length for the interface. type: int role: description: Role of the interface type: str vlan_id: description: Virtual Local Area Network (VLAN) identifier for the interface. type: int description: Details of the file interface. returned: When file interface exists. sample: gateway: 10.**.**.1 id: 65a50e0d-25f9-bd0a-8ca7-62b767ad9845 ip_address: 10.**.**.** ip_port_id: IP_PORT2 is_destination_override_enabled: false is_disabled: false is_dr_test: false name: PROD022_19c8adfb1d41_1d nas_server_id: 6581683c-61a3-76ab-f107-62b767ad9845 prefix_length: 21 role: Production source_parameters: None vlan_id: 0 type: complex