network#

async idem_vra.exec.vra.iaas.network.create_network(hub, ctx, name, projectId, **kwargs)[source]#
Create network Provision a new network based on the passed in constraints. The network should

be destroyed after the machine is destroyed to free up resources. Performs POST /iaas/api/networks

Parameters:

  • name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.

  • projectId (string) – (required in body) The id of the project the current user belongs to.

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

  • customProperties (object) – (optional in body) Additional custom properties that may be used to extend this resource.

  • deploymentId (string) – (optional in body) The id of the deployment that is associated with this resource

  • outboundAccess (boolean) – (optional in body) Flag to indicate if the network needs to have outbound access or not. Default is true. This field will be ignored if there is proper input for networkType customProperty

  • description (string) – (optional in body) A human-friendly description.

  • createGateway (boolean) – (optional in body) Flag to indicate if the network creation should create a gateway. Default is true.

  • constraints (array) – (optional in body) Constraints that are used to drive placement policies for the network that is produced from this specification, related with the network profile. Constraint expressions are matched against tags on existing placement targets.

  • tags (array) – (optional in body) A set of tag keys and optional values that should be set on any resource that is produced from this specification.

async idem_vra.exec.vra.iaas.network.delete_network(hub, ctx, p_id, **kwargs)[source]#

Delete a network Delete a network with a given id Performs DELETE /iaas/api/networks/{id}

Parameters:

  • p_id (string) – (required in path) The ID of the network.

  • forceDelete (boolean) – (optional in query) Controls whether this is a force delete operation. If true, best effort is made for deleting this network. Use with caution as force deleting may cause inconsistencies between the cloud provider and vRA.

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.network.get_machine_network_interface(hub, ctx, p_id, p_networkId, **kwargs)[source]#

Get machine network interface Get network interface with a given id for specific machine Performs GET /iaas/api/machines/{id}/network-interfaces/{networkId}

Parameters:

  • p_id (string) – (required in path) The ID of the machine.

  • p_networkId (string) – (required in path) The ID of the network interface.

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.network.get_network_domain(hub, ctx, p_id, **kwargs)[source]#

Get network domain Get network domain with a given id Performs GET /iaas/api/network-domains/{id}

Parameters:

  • p_id (string) – (required in path) The ID of the network domain.

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.network.get_network_domains(hub, ctx, **kwargs)[source]#

Get network domains Get all network domains. Performs GET /iaas/api/network-domains

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.network.get_network(hub, ctx, p_id, **kwargs)[source]#

Get network Get network with a given id Performs GET /iaas/api/networks/{id}

Parameters:

  • p_id (string) – (required in path) The ID of the network.

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.network.get_networks(hub, ctx, **kwargs)[source]#

Get networks Get all networks Performs GET /iaas/api/networks

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.network.patch_machine_network_interface(hub, ctx, p_id, p_networkId, **kwargs)[source]#
Patch machine network interface Patch network interface with a given id for specific machine. Only name,

description, IPv4 address and custom property updates are supported. The change to name and IPv4 address will not propagate to cloud endpoint for provisioned machines. Performs PATCH /iaas/api/machines/{id}/network-interfaces/{networkId}

Parameters:

  • p_id (string) – (required in path) The ID of the machine.

  • p_networkId (string) – (required in path) The ID of the network interface.

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

  • customProperties (object) – (optional in body) Additional custom properties that may be used to extend the machine. Internal custom properties (for example, prefixed with: “__”) can not be updated.

  • address (string) – (optional in body) Set IPv4 address for the machine network interface. The change will not propagate to cloud endpoint for provisioned machines.

  • name (string) – (optional in body) Network interface name used during machine network interface provisioning. This property only takes effect if it is set before machine provisioning starts. The change will not propagate to cloud endpoint for provisioned machines.

  • description (string) – (optional in body) Describes the network interface of the machine within the scope of your organization and is not propagated to the cloud