mnecas / mnecas.ovirt / 1.5.5 / module / ovirt_storage_connection Module to manage storage connections in oVirt | "added in version" 1.0.0 of mnecas.ovirt" Authors: Ondra Machacek (@machacekondra)mnecas.ovirt.ovirt_storage_connection (1.5.5) — module
Install with ansible-galaxy collection install mnecas.ovirt:==1.5.5
collections: - name: mnecas.ovirt version: 1.5.5
Module to manage storage connections in oVirt
# Examples don't contain auth parameter for simplicity, # look at ovirt_auth module to see how to reuse authentication: # Add new storage connection: - mnecas.ovirt.ovirt_storage_connection: storage: myiscsi address: 10.34.63.199 target: iqn.2016-08-09.domain-01:nickname port: 3260 type: iscsi
# Update the existing storage connection address: - mnecas.ovirt.ovirt_storage_connection: id: 26915c96-92ff-47e5-9e77-b581db2f2d36 address: 10.34.63.204 force: true
# Remove storage connection: - mnecas.ovirt.ovirt_storage_connection: id: 26915c96-92ff-47e5-9e77-b581db2f2d36
id: description: - Id of the storage connection to manage. type: str auth: description: - 'Dictionary with values needed to create HTTP/HTTPS connection to oVirt:' required: true suboptions: ca_file: description: - A PEM file containing the trusted CA certificates. - The certificate presented by the server will be verified using these CA certificates. - If C(ca_file) parameter is not set, system wide CA certificate store is used. - Default value is set by C(OVIRT_CAFILE) environment variable. type: str compress: default: true description: Flag indicating if compression is used for connection. type: bool headers: description: - Dictionary of HTTP headers to be added to each API call. type: dict hostname: description: - A string containing the hostname of the server, usually something like `I(server.example.com)`. - Default value is set by C(OVIRT_HOSTNAME) environment variable. - Either C(url) or C(hostname) is required. type: str insecure: default: false description: - A boolean flag that indicates if the server TLS certificate and host name should be checked. type: bool kerberos: description: - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. type: bool password: description: - The password of the user. - Default value is set by C(OVIRT_PASSWORD) environment variable. required: true type: str timeout: description: Number of seconds to wait for response. type: int token: description: - Token to be used instead of login with username/password. - Default value is set by C(OVIRT_TOKEN) environment variable. type: str url: description: - A string containing the API URL of the server, usually something like `I(https://server.example.com/ovirt-engine/api)`. - Default value is set by C(OVIRT_URL) environment variable. - Either C(url) or C(hostname) is required. type: str username: description: - The name of the user, something like I(admin@internal). - Default value is set by C(OVIRT_USERNAME) environment variable. required: true type: str type: dict path: description: - 'Path of the mount point of the storage. E.g.: /path/to/my/data' type: str port: description: - Port of the iSCSI storage server. type: int type: description: - 'Storage type. For example: I(nfs), I(iscsi), etc.' type: str wait: default: true description: - C(yes) if the module should wait for the entity to get into desired state. type: bool force: default: false description: - This parameter is relevant only when updating a connection. - If I(true) the storage domain don't have to be in I(MAINTENANCE) state, so the storage connection is updated. type: bool state: choices: - present - absent default: present description: - Should the storage connection be present or absent. type: str target: description: - The target IQN for the storage device. type: str address: description: - 'Address of the storage server. E.g.: myserver.mydomain.com' type: str storage: description: - Name of the storage domain to be used with storage connection. type: str timeout: default: 180 description: - The amount of time in seconds the module should wait for the instance to get into desired state. type: int password: description: - A CHAP password for logging into a target. type: str username: description: - A CHAP username for logging into a target. type: str vfs_type: description: - Virtual File System type. type: str nfs_retrans: description: - The number of times to retry a request before attempting further recovery actions. Range 0 to 65535. type: int nfs_timeout: description: - The time in tenths of a second to wait for a response before retrying NFS requests. Range 0 to 65535. type: int nfs_version: description: - 'NFS version. One of: I(auto), I(v3), I(v4) or I(v4_1).' type: str fetch_nested: default: false description: - If I(True) the module will fetch additional data from the API. - It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying C(nested_attributes). type: bool mount_options: description: - Option which will be passed when mounting storage. type: str poll_interval: default: 3 description: - Number of the seconds the module waits until another poll request on entity status is sent. type: int nested_attributes: description: - Specifies list of the attributes which should be fetched from the API. - This parameter apply only when C(fetch_nested) is I(true). elements: str type: list
id: description: ID of the storage connection which is managed returned: On success if storage connection is found. sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c type: str storage_connection: description: 'Dictionary of all the storage connection attributes. Storage connection attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/storage_connection.' returned: On success if storage connection is found. type: dict