loadbalancer#

async idem_vra.exec.vra.iaas.loadbalancer.create_load_balancer(hub, ctx, routes, name, nics, projectId, **kwargs)[source]#

Create load balancer Create load balancer Performs POST /iaas/api/load-balancers

Parameters:
  • routes (array) – (required in body) The load balancer route configuration regarding ports and protocols.

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

  • nics (array) – (required in body) A set of network interface specifications for this load balancer.

  • 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

  • targetLinks (array) – (optional in body) A list of links to target load balancer pool members. Links can be to either a machine or a machine’s network interface.

  • internetFacing (boolean) – (optional in body) An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.

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

  • type (string) – (optional in body) Define the type/variant of load balancer numbers e.g.for NSX the number virtual servers and pool members load balancer can host

  • loggingLevel (string) – (optional in body) Defines logging level for collecting load balancer traffic logs.

  • 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.loadbalancer.delete_load_balancer_operation(hub, ctx, p_id, **kwargs)[source]#

Delete operation for load balancer Second day delete operation for load balancer Performs POST /iaas/api/load-balancers/{id}/operations/delete

Parameters:
  • p_id (string) – (required in path) The ID of the load balancer.

  • forceDelete (boolean) – (optional in query) Controls whether this is a force delete operation. If true, best effort is made for deleting this load balancer. 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.loadbalancer.delete_load_balancer(hub, ctx, p_id, **kwargs)[source]#

Delete load balancer Delete load balancer with a given id Performs DELETE /iaas/api/load-balancers/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the load balancer.

  • forceDelete (boolean) – (optional in query) Controls whether this is a force delete operation. If true, best effort is made for deleting this load balancer. 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.loadbalancer.get_load_balancer_network_interface(hub, ctx, p_id, p_id1, **kwargs)[source]#

Get load balancer network interface Get network interface with a given id for specific load balancer Performs GET /iaas/api/load-balancers/{id}/network-interfaces/{id1}

Parameters:
  • p_id (string) – (required in path) The ID of the load balancer.

  • p_id1 (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.loadbalancer.get_load_balancer(hub, ctx, p_id, **kwargs)[source]#

Get load balancer Get load balancer with a given id Performs GET /iaas/api/load-balancers/{id}

Parameters:
  • p_id (string) – (required in path) The ID of the load balancer.

  • 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.loadbalancer.get_load_balancers(hub, ctx, **kwargs)[source]#

Get load balancers Get all load balancers Performs GET /iaas/api/load-balancers

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.loadbalancer.scale_load_balancer(hub, ctx, p_id, routes, name, nics, projectId, **kwargs)[source]#

Scale operation for load balancer Second day scale operation for load balancer Performs POST /iaas/api/load-balancers/{id}/operations/scale

Parameters:
  • p_id (string) – (required in path) The ID of the load balancer.

  • routes (array) – (required in body) The load balancer route configuration regarding ports and protocols.

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

  • nics (array) – (required in body) A set of network interface specifications for this load balancer.

  • 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

  • targetLinks (array) – (optional in body) A list of links to target load balancer pool members. Links can be to either a machine or a machine’s network interface.

  • internetFacing (boolean) – (optional in body) An Internet-facing load balancer has a publicly resolvable DNS name, so it can route requests from clients over the Internet to the instances that are registered with the load balancer.

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

  • type (string) – (optional in body) Define the type/variant of load balancer numbers e.g.for NSX the number virtual servers and pool members load balancer can host

  • loggingLevel (string) – (optional in body) Defines logging level for collecting load balancer traffic logs.

  • 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.