- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Gets a packet mirroring rule of the specified priority.
HTTP request
GET https://compute.googleapis.com/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
firewallPolicy |
Name of the firewall policy to which the queried rule belongs. |
Query parameters
Parameters | |
---|---|
priority |
The priority of the rule to get from the firewall policy. |
Request body
The request body must be empty.
Response body
Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "kind": string, "ruleName": string, "description": string, "priority": integer, "match": { "srcIpRanges": [ string ], "destIpRanges": [ string ], "layer4Configs": [ { "ipProtocol": string, "ports": [ string ] } ], "srcSecureTags": [ { "name": string, "state": enum } ], "destAddressGroups": [ string ], "srcAddressGroups": [ string ], "srcFqdns": [ string ], "destFqdns": [ string ], "srcRegionCodes": [ string ], "destRegionCodes": [ string ], "destThreatIntelligences": [ string ], "srcThreatIntelligences": [ string ], "srcNetworkScope": enum, "srcNetworks": [ string ], "destNetworkScope": enum }, "action": string, "securityProfileGroup": string, "tlsInspect": boolean, "direction": enum, "targetResources": [ string ], "enableLogging": boolean, "ruleTupleCount": integer, "targetServiceAccounts": [ string ], "targetSecureTags": [ { "name": string, "state": enum } ], "disabled": boolean } |
Fields | |
---|---|
kind |
[Output only] Type of the resource. Returns |
ruleName |
An optional name for the rule. This field is not a unique identifier and can be updated. |
description |
An optional description for this resource. |
priority |
An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. |
match |
A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. |
match.srcIpRanges[] |
CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. |
match.destIpRanges[] |
CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. |
match.layer4Configs[] |
Pairs of IP protocols and ports that the rule should match. |
match.layer4Configs[].ipProtocol |
The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings ( |
match.layer4Configs[].ports[] |
An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: |
match.srcSecureTags[] |
firewallPolicies.list of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the |
match.srcSecureTags[].name |
Name of the secure tag, created with TagManager's TagValue API. |
match.srcSecureTags[].state |
[Output Only] State of the secure tag, either |
match.destAddressGroups[] |
Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. |
match.srcAddressGroups[] |
Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. |
match.srcFqdns[] |
Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. |
match.destFqdns[] |
Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. |
match.srcRegionCodes[] |
Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. |
match.destRegionCodes[] |
Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. |
match.destThreatIntelligences[] |
Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. |
match.srcThreatIntelligences[] |
Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. |
match.srcNetworkScope |
Network scope of the traffic source. |
match.srcNetworks[] |
Networks of the traffic source. It can be either a full or partial url. |
match.destNetworkScope |
Network scope of the traffic destination. |
action |
The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". |
securityProfileGroup |
A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. |
tlsInspect |
Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. |
direction |
The direction in which this rule applies. |
targetResources[] |
A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. |
enableLogging |
Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. |
ruleTupleCount |
[Output Only] Calculation of the complexity of a single firewall policy rule. |
targetServiceAccounts[] |
A list of service accounts indicating the sets of instances that are applied with this rule. |
targetSecureTags[] |
A list of secure tags that controls which instances the firewall rule applies to. If |
targetSecureTags[].name |
Name of the secure tag, created with TagManager's TagValue API. |
targetSecureTags[].state |
[Output Only] State of the secure tag, either |
disabled |
Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute.readonly
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.firewallPolicies.get
To find predefined roles that contain those permissions, see Compute Engine IAM Roles.