appliance_networking_interfaces_info
Get information about a particular network interface
Collection: vmware.vmware_rest
Full Name: vmware.vmware_rest.appliance_networking_interfaces_info
Synopsis
Get information about a particular network interface
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| vcenter_hostname | string | yes | The hostname or IP address of the vSphere vCenter | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead. | ||||
| vcenter_username | string | yes | The vSphere vCenter username | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead. | ||||
| vcenter_password | string | yes | The vSphere vCenter password | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead. | ||||
| vcenter_validate_certs | bool | true | Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. | |
| If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. | ||||
| vcenter_rest_log_file | string | You can use this optional parameter to set the location of a log file. | ||
| This file will be used to record the HTTP REST interaction. | ||||
| The file will be stored on the host that runs the module. | ||||
| If the value is not specified in the task, the value of | ||||
| environment variable C(VMWARE_REST_LOG_FILE) will be used instead. | ||||
| session_timeout | float | Timeout settings for client session. | ||
| The maximal number of seconds for the whole operation including connection establishment, request sending and response. | ||||
| The default value is 300s. | ||||
| interface_name | string | Network interface, for example, “nic0”. | ||
| The parameter must be the id of a resource returned by M(vmware.vmware_rest.appliance_networking_interfaces_info). Required with I(state=[‘get’]) |
Example
yaml
- name: Get a list of the network interfaces
vmware.vmware_rest.appliance_networking_interfaces_info:
register: result
- name: Get details about one network interfaces
vmware.vmware_rest.appliance_networking_interfaces_info:
interface_name: nic0
register: result