Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2021, Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
# template: header.j2
# This module is autogenerated by vmware_rest_code_generator.
# See: https://github.com/ansible-collections/vmware_rest_code_generator
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r"""
module: vcenter_network_info
short_description: Returns information about at most 1000 visible (subject to permission
checks) networks in vCenter matching the {@link FilterSpec}.
description: Returns information about at most 1000 visible (subject to permission
checks) networks in vCenter matching the {@link FilterSpec}.
options:
datacenters:
aliases:
- filter_datacenters
description:
- Datacenters that must contain the network for the network to match the filter.
elements: str
type: list
folders:
aliases:
- filter_folders
description:
- Folders that must contain the network for the network to match the filter.
elements: str
type: list
names:
aliases:
- filter_names
description:
- Names that networks must have to match the filter (see {@link Summary#name}).
elements: str
type: list
networks:
description:
- Identifiers of networks that can match the filter.
elements: str
type: list
session_timeout:
description:
- '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.
type: float
version_added: 2.1.0
types:
aliases:
- filter_types
description:
- Types that networks must have to match the filter (see {@link Summary#type}).
elements: str
type: list
vcenter_hostname:
description:
- 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.
required: true
type: str
vcenter_password:
description:
- 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.
required: true
type: str
vcenter_rest_log_file:
description:
- '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 run 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.
type: str
vcenter_username:
description:
- 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.
required: true
type: str
vcenter_validate_certs:
default: true
description:
- 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.
type: bool
author:
- Ansible Cloud Team (@ansible-collections)
version_added: 0.1.0
requirements:
- vSphere 7.0.2 or greater
- python >= 3.6
- aiohttp
notes:
- Tested on vSphere 7.0.2
"""
EXAMPLES = r"""
- name: Get the dvswitch called my-portgroup
vmware.vmware_rest.vcenter_network_info:
filter_types: DISTRIBUTED_PORTGROUP
filter_names: my-portrgoup
register: my_portgroup
- name: Get a list of the networks
vmware.vmware_rest.vcenter_network_info:
register: my_network_value
- name: Get a list of the networks with a filter
vmware.vmware_rest.vcenter_network_info:
filter_types: STANDARD_PORTGROUP
register: my_standard_portgroup_value
"""
RETURN = r"""
# content generated by the update_return_section callback# task: Get a list of the networks
value:
description: Get a list of the networks
returned: On success
sample:
- name: my-portrgoup
network: dvportgroup-1023
type: DISTRIBUTED_PORTGROUP
- name: dvswitch1-DVUplinks-1021
network: dvportgroup-1022
type: DISTRIBUTED_PORTGROUP
- name: VM Network
network: network-1017
type: STANDARD_PORTGROUP
- name: second_vswitch
network: network-1019
type: STANDARD_PORTGROUP
type: list
"""
# This structure describes the format of the data expected by the end-points
PAYLOAD_FORMAT = {
"list": {
"query": {
"datacenters": "datacenters",
"folders": "folders",
"names": "names",
"networks": "networks",
"types": "types",
},
"body": {},
"path": {},
}
} # pylint: disable=line-too-long
import json
import socket
from ansible.module_utils.basic import env_fallback
try:
from ansible_collections.cloud.common.plugins.module_utils.turbo.exceptions import (
EmbeddedModuleFailure,
)
from ansible_collections.cloud.common.plugins.module_utils.turbo.module import (
AnsibleTurboModule as AnsibleModule,
)
AnsibleModule.collection_name = "vmware.vmware_rest"
except ImportError:
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.vmware.vmware_rest.plugins.module_utils.vmware_rest import (
build_full_device_list,
exists,
gen_args,
get_device_info,
get_subdevice_type,
list_devices,
open_session,
prepare_payload,
update_changed_flag,
session_timeout,
)
def prepare_argument_spec():
argument_spec = {
"vcenter_hostname": dict(
type="str", required=True, fallback=(env_fallback, ["VMWARE_HOST"]),
),
"vcenter_username": dict(
type="str", required=True, fallback=(env_fallback, ["VMWARE_USER"]),
),
"vcenter_password": dict(
type="str",
required=True,
no_log=True,
fallback=(env_fallback, ["VMWARE_PASSWORD"]),
),
"vcenter_validate_certs": dict(
type="bool",
required=False,
default=True,
fallback=(env_fallback, ["VMWARE_VALIDATE_CERTS"]),
),
"vcenter_rest_log_file": dict(
type="str",
required=False,
fallback=(env_fallback, ["VMWARE_REST_LOG_FILE"]),
),
"session_timeout": dict(
type="float",
required=False,
fallback=(env_fallback, ["VMWARE_SESSION_TIMEOUT"]),
),
}
argument_spec["datacenters"] = {
"aliases": ["filter_datacenters"],
"type": "list",
"elements": "str",
}
argument_spec["folders"] = {
"aliases": ["filter_folders"],
"type": "list",
"elements": "str",
}
argument_spec["names"] = {
"aliases": ["filter_names"],
"type": "list",
"elements": "str",
}
argument_spec["networks"] = {"type": "list", "elements": "str"}
argument_spec["types"] = {
"aliases": ["filter_types"],
"type": "list",
"elements": "str",
}
return argument_spec
async def main():
required_if = list([])
module_args = prepare_argument_spec()
module = AnsibleModule(
argument_spec=module_args, required_if=required_if, supports_check_mode=True
)
if not module.params["vcenter_hostname"]:
module.fail_json("vcenter_hostname cannot be empty")
if not module.params["vcenter_username"]:
module.fail_json("vcenter_username cannot be empty")
if not module.params["vcenter_password"]:
module.fail_json("vcenter_password cannot be empty")
try:
session = await open_session(
vcenter_hostname=module.params["vcenter_hostname"],
vcenter_username=module.params["vcenter_username"],
vcenter_password=module.params["vcenter_password"],
validate_certs=module.params["vcenter_validate_certs"],
log_file=module.params["vcenter_rest_log_file"],
)
except EmbeddedModuleFailure as err:
module.fail_json(err.get_message())
result = await entry_point(module, session)
module.exit_json(**result)
# template: info_list_and_get_module.j2
def build_url(params):
_in_query_parameters = PAYLOAD_FORMAT["list"]["query"].keys()
return ("https://{vcenter_hostname}" "/api/vcenter/network").format(
**params
) + gen_args(params, _in_query_parameters)
async def entry_point(module, session):
url = build_url(module.params)
async with session.get(url, **session_timeout(module.params)) as resp:
_json = await resp.json()
if "value" not in _json: # 7.0.2+
_json = {"value": _json}
return await update_changed_flag(_json, resp.status, "get")
if __name__ == "__main__":
import asyncio
current_loop = asyncio.get_event_loop_policy().get_event_loop()
current_loop.run_until_complete(main())