3.1.5.31 securityTags
A securityTags resource represents a mechanism to modify and apply firewall policies to a group of network interface cards (NICs). securityTags resources can be assigned to network interfaces (section 3.1.5.11). This means that any access control list (ACL) (section 3.1.5.1) associated with the security tag are also applied to each NIC associated with the security tag. Also, security tags can be used as the source or destination field of an ACL rule (section 3.1.5.1.2). If this happens, then the IP addresses of newly associated NICs are included in the source or destination field of that ACL rule.
It is invoked through the following v5 URI.
-
https://<url>/networking/v5/securityTags/{resourceId}
url: The address or name of the REST server of the Network Controller.
resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.
Note The server MAY support additional versions, v5 or later, in the URI.
The following HTTP methods can be performed on this resource.
HTTP method |
Section |
Description |
---|---|---|
PUT |
Create a new securityTags resource or update an existing securityTags resource. |
|
GET |
Get one securityTags resource. |
|
GET ALL |
List all securityTags resources in the Network Controller. |
|
DELETE |
Delete a securityTags resource. |
The following property elements are valid.
Element name |
Type |
Description |
---|---|---|
etag |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
provisioningState |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
type |
Optional |
A string that can be used to filter security tags after listing all security tags. |
accessControlList |
Read-only |
A reference to an accessControlLists resource (section 3.1.5.1) that defines the ACL rules to be applied to each NIC associated with this security tag. |
networkInterfaces |
Read-only |
An array of references to networkInterfaces resources (section 3.1.5.11) that this security tag is associated with. |
aclRulesAsSource |
Read-only |
An array of references to aclRules resources (section 3.1.5.1.2) that include this security tag in its sourceSecurityTags field. |
aclRulesAsDestination |
Read-only |
An array of references to aclRules resources that include this security tag in its destinationSecurityTags field. |