oci_security_rule_actions – Perform actions on a SecurityRule resource in Oracle Cloud Infrastructure¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Perform actions on a SecurityRule resource in Oracle Cloud Infrastructure
For action=add_network_security_group_security_rules, adds one or more security rules to the specified network security group.
For action=remove_network_security_group_security_rules, removes one or more security rules from the specified network security group.
For action=update_network_security_group_security_rules, updates one or more security rules in the specified network security group.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter				Choices/Defaults	Comments
action - / required				Choices: add_network_security_group_security_rules remove_network_security_group_security_rules update_network_security_group_security_rules	The action to perform on the SecurityRule.
api_user string					The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string					Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string					Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string					Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
auth_type string				Choices: api_key ← instance_principal instance_obo_user	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible` playbooks within an OCI compute instance.
config_file_location string					Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name string					The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
network_security_group_id - / required					The OCID of the network security group. aliases: id
region string					The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
security_rule_ids list					The Oracle-assigned ID of each SecurityRule to be deleted. Applicable only for action=remove_network_security_group_security_rules.
security_rules list					The NSG security rules to add. Applicable only for action=add_network_security_group_security_rulesaction=update_network_security_group_security_rules.
	description -				An optional description of your choice for the rule. Avoid entering confidential information.
	destination -				Conceptually, this is the range of IP addresses that a packet originating from the instance can go to. Allowed values: * An IP address range in CIDR notation. For example: `192.168.1.0/24` * The `cidrBlock` value for a Service, if you're setting up a security rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`. * The OCID of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG.
	destination_type -			Choices: CIDR_BLOCK SERVICE_CIDR_BLOCK NETWORK_SECURITY_GROUP	Type of destination for the rule. Required if `direction` = `EGRESS`. Allowed values: * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a Service (the rule is for traffic destined for a particular `Service` through a service gateway). * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the OCID of a NetworkSecurityGroup.
	direction - / required			Choices: EGRESS INGRESS	Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, or `INGRESS` for rules to allow inbound IP packets.
	icmp_options dictionary				Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - ICMP Parameters - ICMPv6 Parameters If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each.
		code integer			The ICMP code (optional).
		type integer / required			The ICMP type.
	id -				The Oracle-assigned ID of the security rule that you want to update. You can't change this value. Example: `04ABEC`
	is_stateless boolean			Choices: no yes	A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.
	protocol - / required				The transport protocol. Specify either `all` or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
	source -				Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. Allowed values: * An IP address range in CIDR notation. For example: `192.168.1.0/24` * The `cidrBlock` value for a Service, if you're setting up a security rule for traffic coming from a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`. * The OCID of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG.
	source_type -			Choices: CIDR_BLOCK SERVICE_CIDR_BLOCK NETWORK_SECURITY_GROUP	Type of source for the rule. Required if `direction` = `INGRESS`. * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a Service (the rule is for traffic coming from a particular `Service` through a service gateway). * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the OCID of a NetworkSecurityGroup.
	tcp_options dictionary				Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.
		destination_port_range dictionary			An inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.
			max integer / required		The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.
			min integer / required		The minimum port number. Must not be greater than the maximum port number.
		source_port_range dictionary			An inclusive range of allowed source ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.
			max integer / required		The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.
			min integer / required		The minimum port number. Must not be greater than the maximum port number.
	udp_options dictionary				Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.
		destination_port_range dictionary			An inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.
			max integer / required		The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.
			min integer / required		The minimum port number. Must not be greater than the maximum port number.
		source_port_range dictionary			An inclusive range of allowed source ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.
			max integer / required		The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.
			min integer / required		The minimum port number. Must not be greater than the maximum port number.
tenancy string					OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Perform action add_network_security_group_security_rules on security_rule
  oci_security_rule_actions:
    network_security_group_id: ocid1.networksecuritygroup.oc1..xxxxxxEXAMPLExxxxxx
    security_rules:
    - description: Example ingress security rule
      source_type: CIDR_BLOCK
      source: 10.0.0.0/16
      direction: INGRESS
      protocol: all
    - description: Example egress security rule
      destination_type: CIDR_BLOCK
      destination: 10.0.0.0/16
      direction: EGRESS
      protocol: all
    action: add_network_security_group_security_rules

- name: Perform action remove_network_security_group_security_rules on security_rule
  oci_security_rule_actions:
    network_security_group_id: ocid1.networksecuritygroup.oc1..xxxxxxEXAMPLExxxxxx
    security_rule_ids:
    - 880233
    - 203597
    action: remove_network_security_group_security_rules

- name: Perform action update_network_security_group_security_rules on security_rule
  oci_security_rule_actions:
    network_security_group_id: ocid1.networksecuritygroup.oc1..xxxxxxEXAMPLExxxxxx
    security_rules:
    - description: Example ingress security rule - updated
      id: 203597
      source_type: CIDR_BLOCK
      source: 10.0.0.0/24
      direction: INGRESS
      protocol: all
    - description: Example egress security rule - updated
      destination_type: CIDR_BLOCK
      destination: 10.0.0.0/24
      direction: EGRESS
      id: 880233
      protocol: all
    action: update_network_security_group_security_rules

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key					Returned	Description
security_rule complex					on success	Details of the SecurityRule resource acted upon by the current operation Sample: {'security_rules': [{'source': 'source_example', 'destination': 'destination_example', 'icmp_options': {'code': 56, 'type': 56}, 'description': 'description_example', 'is_stateless': True, 'destination_type': 'CIDR_BLOCK', 'id': '04ABEC', 'source_type': 'CIDR_BLOCK', 'is_valid': True, 'protocol': 'protocol_example', 'direction': 'EGRESS', 'tcp_options': {'destination_port_range': {'min': 56, 'max': 56}, 'source_port_range': {'min': 56, 'max': 56}}, 'udp_options': {'destination_port_range': {'min': 56, 'max': 56}, 'source_port_range': {'min': 56, 'max': 56}}, 'time_created': '2013-10-20T19:20:30+01:00'}]}
	security_rules complex				on success	The NSG security rules that were added.
		description string			on success	An optional description of your choice for the rule. Sample: description_example
		destination string			on success	Conceptually, this is the range of IP addresses that a packet originating from the instance can go to. Allowed values: * An IP address range in CIDR notation. For example: `192.168.1.0/24` * The `cidrBlock` value for a Service, if you're setting up a security rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`. * The OCID of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG. Sample: destination_example
		destination_type string			on success	Type of destination for the rule. Required if `direction` = `EGRESS`. Allowed values: * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation. * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a Service (the rule is for traffic destined for a particular `Service` through a service gateway). * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the OCID of a NetworkSecurityGroup. Sample: CIDR_BLOCK
		direction string			on success	Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, or `INGRESS` for rules to allow inbound IP packets. Sample: EGRESS
		icmp_options complex			on success	Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - ICMP Parameters - ICMPv6 Parameters If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don't Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security rule for each.
			code integer		on success	The ICMP code (optional). Sample: 56
			type integer		on success	The ICMP type. Sample: 56
		id string			on success	An Oracle-assigned identifier for the security rule. You specify this ID when you want to update or delete the rule. Example: `04ABEC` Sample: 04ABEC
		is_stateless boolean			on success	A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic. Sample: True
		is_valid boolean			on success	Whether the rule is valid. The value is `True` when the rule is first created. If the rule's `source` or `destination` is a network security group, the value changes to `False` if that network security group is deleted. Sample: True
		protocol string			on success	The transport protocol. Specify either `all` or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). Sample: protocol_example
		source string			on success	Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. Allowed values: * An IP address range in CIDR notation. For example: `192.168.1.0/24` * The `cidrBlock` value for a Service, if you're setting up a security rule for traffic coming from a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`. * The OCID of a NetworkSecurityGroup in the same VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control traffic between VNICs in the same NSG. Sample: source_example
		source_type string			on success	Type of source for the rule. Required if `direction` = `INGRESS`. * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation. * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a Service (the rule is for traffic coming from a particular `Service` through a service gateway). * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the OCID of a NetworkSecurityGroup. Sample: CIDR_BLOCK
		tcp_options complex			on success	Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.
			destination_port_range complex		on success	An inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.
				max integer	on success	The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value. Sample: 56
				min integer	on success	The minimum port number. Must not be greater than the maximum port number. Sample: 56
			source_port_range complex		on success	An inclusive range of allowed source ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.
				max integer	on success	The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value. Sample: 56
				min integer	on success	The minimum port number. Must not be greater than the maximum port number. Sample: 56
		time_created string			on success	The date and time the security rule was created. Format defined by RFC3339. Sample: 2013-10-20 19:20:30+01:00
		udp_options complex			on success	Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.
			destination_port_range complex		on success	An inclusive range of allowed destination ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.
				max integer	on success	The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value. Sample: 56
				min integer	on success	The minimum port number. Must not be greater than the maximum port number. Sample: 56
			source_port_range complex		on success	An inclusive range of allowed source ports. Use the same number for the min and max to indicate a single port. Defaults to all ports if not specified.
				max integer	on success	The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value. Sample: 56
				min integer	on success	The minimum port number. Must not be greater than the maximum port number. Sample: 56

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Manoj Meda (@manojmeda)
Mike Ross (@mross22)
Nabeel Al-Saber (@nalsaber)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

oci_security_rule_actions – Perform actions on a SecurityRule resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶