securitygroup

async idem_vra.exec.vra.iaas.securitygroup.change_security_groups(hub, ctx, p_id, _links, id, **kwargs)

Change security groups for a vSphere machine Change security groups for a vSphere machine network interfaces. Securing group

that is part of the same deployment can be added or removed for a machine network interface. Performs POST /iaas/api/machines/{id}/operations/change-security-groups

Parameters:

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

• _links (object) – (required in body) HATEOAS of the entity

• id (string) – (required in body) The id of this resource instance

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

• owner (string) – (optional in body) Email of the user that owns the entity.

• createdAt (string) – (optional in body) Date when the entity was created. The date is in ISO 8601 and UTC.

• networkInterfaceSpecifications (array) – (optional in body) A set of network interface controller specifications for this machine. If not specified, then no reconfiguration will be performed.

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

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

• orgId (string) – (optional in body) The id of the organization this entity belongs to.

• updatedAt (string) – (optional in body) Date when the entity was last updated. The date is ISO 8601 and UTC.

async idem_vra.exec.vra.iaas.securitygroup.create_on_demand_security_group(hub, ctx, name, projectId, **kwargs)

Create on-demand security group Provision a new on-demand security group Performs POST /iaas/api/security-groups

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

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

• rules (array) – (optional in body) List of security rules.

• 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.securitygroup.delete_security_group(hub, ctx, p_id, **kwargs)

Delete an on-demand security group Delete an on-demand security group with a given id Performs DELETE /iaas/api/security-groups/{id}

Parameters:

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

• forceDelete (boolean) – (optional in query) Controls whether this is a force delete operation. If true, best effort is made for deleting this security group. 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.securitygroup.get_security_group(hub, ctx, p_id, **kwargs)

Get security group Get security group with a given id Performs GET /iaas/api/security-groups/{id}

Parameters:

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

• 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.securitygroup.get_security_groups(hub, ctx, **kwargs)

Get security groups Get all security groups Performs GET /iaas/api/security-groups

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.securitygroup.reconfigure_security_group(hub, ctx, p_id, name, projectId, **kwargs)

Reconfigure operation for security group Day-2 reconfigure operation for new security groups provisioned by vRA. This is

not supported for ‘existing’ security groups Performs POST /iaas/api/security-groups/{id}/operations/reconfigure

Parameters:

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

• 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

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

• rules (array) – (optional in body) List of security rules.

• 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.securitygroup.update_security_group(hub, ctx, p_id, **kwargs)

Update security group. Update security group. Only tag updates are supported. Performs PATCH /iaas/api/security-groups/{id}

Parameters:

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

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

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