packet_mirroring_rule

Creates, updates, deletes, gets or lists a packet_mirroring_rule resource.

Overview

Name	packet_mirroring_rule
Type	Resource
Id	google.compute.packet_mirroring_rule

Fields

The following fields are returned by SELECT queries:

get_packet_mirroring_rule

Successful response

Name	Datatype	Description
action	string	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".
description	string	An optional description for this resource.
direction	string	The direction in which this rule applies.
disabled	boolean	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.
enableLogging	boolean	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.
kind	string	[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. (default: compute#firewallPolicyRule)
match	object	A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. (id: FirewallPolicyRuleMatcher)
priority	integer (int32)	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.
ruleName	string	An optional name for the rule. This field is not a unique identifier and can be updated.
ruleTupleCount	integer (int32)	[Output Only] Calculation of the complexity of a single firewall policy rule.
securityProfileGroup	string	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.
targetResources	array	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.
targetSecureTags	array	A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
targetServiceAccounts	array	A list of service accounts indicating the sets of instances that are applied with this rule.
tlsInspect	boolean	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_packet_mirroring_rule	select	project, firewallPolicy	priority	Gets a packet mirroring rule of the specified priority.
add_packet_mirroring_rule	insert	project, firewallPolicy	maxPriority, minPriority, requestId	Inserts a packet mirroring rule into a firewall policy.
patch_packet_mirroring_rule	update	project, firewallPolicy	priority, requestId	Patches a packet mirroring rule of the specified priority.
remove_packet_mirroring_rule	delete	project, firewallPolicy	priority, requestId	Deletes a packet mirroring rule of the specified priority.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
firewallPolicy	string
project	string
maxPriority	integer (int32)
minPriority	integer (int32)
priority	integer (int32)
requestId	string

SELECT examples

get_packet_mirroring_rule

Gets a packet mirroring rule of the specified priority.

SELECT
action,
description,
direction,
disabled,
enableLogging,
kind,
match,
priority,
ruleName,
ruleTupleCount,
securityProfileGroup,
targetResources,
targetSecureTags,
targetServiceAccounts,
tlsInspect
FROM google.compute.packet_mirroring_rule
WHERE project = '{{ project }}' -- required
AND firewallPolicy = '{{ firewallPolicy }}' -- required
AND priority = '{{ priority }}';

INSERT examples

add_packet_mirroring_rule

Inserts a packet mirroring rule into a firewall policy.

INSERT INTO google.compute.packet_mirroring_rule (
data__kind,
data__ruleName,
data__description,
data__priority,
data__match,
data__action,
data__securityProfileGroup,
data__tlsInspect,
data__direction,
data__targetResources,
data__enableLogging,
data__ruleTupleCount,
data__targetServiceAccounts,
data__targetSecureTags,
data__disabled,
project,
firewallPolicy,
maxPriority,
minPriority,
requestId
)
SELECT 
'{{ kind }}',
'{{ ruleName }}',
'{{ description }}',
{{ priority }},
'{{ match }}',
'{{ action }}',
'{{ securityProfileGroup }}',
{{ tlsInspect }},
'{{ direction }}',
'{{ targetResources }}',
{{ enableLogging }},
{{ ruleTupleCount }},
'{{ targetServiceAccounts }}',
'{{ targetSecureTags }}',
{{ disabled }},
'{{ project }}',
'{{ firewallPolicy }}',
'{{ maxPriority }}',
'{{ minPriority }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: packet_mirroring_rule
  props:
    - name: project
      value: string
      description: Required parameter for the packet_mirroring_rule resource.
    - name: firewallPolicy
      value: string
      description: Required parameter for the packet_mirroring_rule resource.
    - name: kind
      value: string
      description: >
        [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.
        
      default: compute#firewallPolicyRule
    - name: ruleName
      value: string
      description: >
        An optional name for the rule. This field is not a unique identifier and can be updated.
        
    - name: description
      value: string
      description: >
        An optional description for this resource.
        
    - name: priority
      value: integer
      description: >
        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.
        
    - name: match
      value: object
      description: >
        A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
        
    - name: action
      value: string
      description: >
        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".
        
    - name: securityProfileGroup
      value: string
      description: >
        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.
        
    - name: tlsInspect
      value: boolean
      description: >
        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.
        
    - name: direction
      value: string
      description: >
        The direction in which this rule applies.
        
      valid_values: ['EGRESS', 'INGRESS']
    - name: targetResources
      value: array
      description: >
        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.
        
    - name: enableLogging
      value: boolean
      description: >
        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.
        
    - name: ruleTupleCount
      value: integer
      description: >
        [Output Only] Calculation of the complexity of a single firewall policy rule.
        
    - name: targetServiceAccounts
      value: array
      description: >
        A list of service accounts indicating the sets of instances that are applied with this rule.
        
    - name: targetSecureTags
      value: array
      description: >
        A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
        
    - name: disabled
      value: boolean
      description: >
        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.
        
    - name: maxPriority
      value: integer (int32)
    - name: minPriority
      value: integer (int32)
    - name: requestId
      value: string

UPDATE examples

patch_packet_mirroring_rule

Patches a packet mirroring rule of the specified priority.

UPDATE google.compute.packet_mirroring_rule
SET 
data__kind = '{{ kind }}',
data__ruleName = '{{ ruleName }}',
data__description = '{{ description }}',
data__priority = {{ priority }},
data__match = '{{ match }}',
data__action = '{{ action }}',
data__securityProfileGroup = '{{ securityProfileGroup }}',
data__tlsInspect = {{ tlsInspect }},
data__direction = '{{ direction }}',
data__targetResources = '{{ targetResources }}',
data__enableLogging = {{ enableLogging }},
data__ruleTupleCount = {{ ruleTupleCount }},
data__targetServiceAccounts = '{{ targetServiceAccounts }}',
data__targetSecureTags = '{{ targetSecureTags }}',
data__disabled = {{ disabled }}
WHERE 
project = '{{ project }}' --required
AND firewallPolicy = '{{ firewallPolicy }}' --required
AND priority = '{{ priority}}'
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples

remove_packet_mirroring_rule

Deletes a packet mirroring rule of the specified priority.

DELETE FROM google.compute.packet_mirroring_rule
WHERE project = '{{ project }}' --required
AND firewallPolicy = '{{ firewallPolicy }}' --required
AND priority = '{{ priority }}'
AND requestId = '{{ requestId }}';