networkprofile#

async idem_vra.exec.vra.iaas.networkprofile.create_network_profile(hub, ctx, regionId, name, **kwargs)[source]#

Create network profile Create network profile Performs POST /iaas/api/network-profiles

Parameters:
  • regionId (string) – (required in body) The Id of the region for which this profile is created

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

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

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

  • isolationNetworkDomainCIDR (string) – (optional in body) CIDR of the isolation network domain.

  • isolationNetworkDomainId (string) – (optional in body) The Id of the network domain used for creating isolated networks.

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

  • externalIpBlockIds (array) – (optional in body) List of external IP blocks coming from an external IPAM provider that can be used to create subnetworks inside them

  • fabricNetworkIds (array) – (optional in body) A list of fabric network Ids which are assigned to the network profile.

  • customProperties (object) – (optional in body) Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router (NSX-V only). For isolationType subnet, tier0LogicalRouterStateLink identifies the on-demand network tier-0 logical router (NSX-T only). onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.

  • securityGroupIds (array) – (optional in body) A list of security group Ids which are assigned to the network profile.

  • isolationExternalFabricNetworkId (string) – (optional in body) The Id of the fabric network used for outbound access.

  • isolationType (string) – (optional in body) Specifies the isolation type e.g. none, subnet or security group

  • isolatedNetworkCIDRPrefix (integer) – (optional in body) The CIDR prefix length to be used for the isolated networks that are created with the network profile.

  • loadBalancerIds (array) – (optional in body) A list of load balancers which are assigned to the network profile.

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

Delete network profile Delete network profile with a given id Performs DELETE /iaas/api/network-profiles/{id}

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

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

Get network profile Get network profile with a given id Performs GET /iaas/api/network-profiles/{id}

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

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

Get network profiles Get all network profiles Performs GET /iaas/api/network-profiles

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

  • top (integer) – (optional in query) Number of records you want to get.

  • skip (integer) – (optional in query) Number of records you want to skip.

  • count (boolean) – (optional in query) Flag which when specified, regardless of the assigned value, shows the total number of records. If the collection has a filter it shows the number of records matching the filter.

  • select (string) – (optional in query) Select a subset of properties to include in the response.

  • filter (string) – (optional in query) Filter the results by a specified predicate expression. Operators: eq, ne, and, or.

async idem_vra.exec.vra.iaas.networkprofile.update_network_profile(hub, ctx, p_id, regionId, name, **kwargs)[source]#

Update network profile Update network profile Performs PATCH /iaas/api/network-profiles/{id}

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

  • regionId (string) – (required in body) The Id of the region for which this profile is created

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

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

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

  • isolationNetworkDomainCIDR (string) – (optional in body) CIDR of the isolation network domain.

  • isolationNetworkDomainId (string) – (optional in body) The Id of the network domain used for creating isolated networks.

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

  • externalIpBlockIds (array) – (optional in body) List of external IP blocks coming from an external IPAM provider that can be used to create subnetworks inside them

  • fabricNetworkIds (array) – (optional in body) A list of fabric network Ids which are assigned to the network profile.

  • customProperties (object) – (optional in body) Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router (NSX-V only). For isolationType subnet, tier0LogicalRouterStateLink identifies the on-demand network tier-0 logical router (NSX-T only). onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.

  • securityGroupIds (array) – (optional in body) A list of security group Ids which are assigned to the network profile.

  • isolationExternalFabricNetworkId (string) – (optional in body) The Id of the fabric network used for outbound access.

  • isolationType (string) – (optional in body) Specifies the isolation type e.g. none, subnet or security group

  • isolatedNetworkCIDRPrefix (integer) – (optional in body) The CIDR prefix length to be used for the isolated networks that are created with the network profile.

  • loadBalancerIds (array) – (optional in body) A list of load balancers which are assigned to the network profile.