oracle.oci.oci_network_security_group_security_rule_actions – Perform actions on a NetworkSecurityGroupSecurityRule resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 4.14.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_network_security_group_security_rule_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a NetworkSecurityGroupSecurityRule resource in Oracle Cloud Infrastructure
For action=add, adds one or more security rules to the specified network security group.
For action=remove, removes one or more security rules from the specified network security group.
For action=update, 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 >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
action
string
/ required
|
|
The action to perform on the NetworkSecurityGroupSecurityRule.
|
|||
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_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
|||
auth_type
string
|
|
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. |
|||
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
||||
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
string
/ 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
/ elements=string
|
The Oracle-assigned ID of each SecurityRule to be deleted.
Applicable only for action=remove.
|
||||
security_rules
list
/ elements=dictionary
|
The NSG security rules to add.
Applicable only for action=addaction=update.
|
||||
description
string
|
An optional description of your choice for the rule. Avoid entering confidential information.
|
||||
destination
string
|
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` or `2001:0db8:0123:45::/56` IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
* 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
string
|
|
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
string
/ required
|
|
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
|
|||||
code
integer
|
The ICMP code (optional).
|
||||
type
integer
/ required
|
The ICMP type.
|
||||
id
string
|
The Oracle-assigned ID of the security rule that you want to update. You can't change this value.
Example: `04ABEC`
|
||||
is_stateless
boolean
|
|
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
string
/ 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
string
|
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` or `2001:0db8:0123:45::/56` IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
* 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
string
|
|
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
|
|||||
destination_port_range
dictionary
|
|||||
max
integer
/ required
|
The maximum port number, which must not be less 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, which must not be greater than the maximum port number.
|
||||
source_port_range
dictionary
|
|||||
max
integer
/ required
|
The maximum port number, which must not be less 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, which must not be greater than the maximum port number.
|
||||
udp_options
dictionary
|
|||||
destination_port_range
dictionary
|
|||||
max
integer
/ required
|
The maximum port number, which must not be less 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, which must not be greater than the maximum port number.
|
||||
source_port_range
dictionary
|
|||||
max
integer
/ required
|
The maximum port number, which must not be less 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, which 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 on network_security_group_security_rule
oci_network_security_group_security_rule_actions:
# required
network_security_group_id: "ocid1.networksecuritygroup.oc1..xxxxxxEXAMPLExxxxxx"
action: add
# optional
security_rules:
- # required
direction: EGRESS
protocol: protocol_example
# optional
description: description_example
destination: destination_example
destination_type: CIDR_BLOCK
icmp_options:
# required
type: 56
# optional
code: 56
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
is_stateless: true
source: source_example
source_type: CIDR_BLOCK
tcp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
udp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
- name: Perform action remove on network_security_group_security_rule
oci_network_security_group_security_rule_actions:
# required
network_security_group_id: "ocid1.networksecuritygroup.oc1..xxxxxxEXAMPLExxxxxx"
action: remove
# optional
security_rule_ids: [ "security_rule_ids_example" ]
- name: Perform action update on network_security_group_security_rule
oci_network_security_group_security_rule_actions:
# required
network_security_group_id: "ocid1.networksecuritygroup.oc1..xxxxxxEXAMPLExxxxxx"
action: update
# optional
security_rules:
- # required
direction: EGRESS
protocol: protocol_example
# optional
description: description_example
destination: destination_example
destination_type: CIDR_BLOCK
icmp_options:
# required
type: 56
# optional
code: 56
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
is_stateless: true
source: source_example
source_type: CIDR_BLOCK
tcp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
udp_options:
# optional
destination_port_range:
# required
max: 56
min: 56
source_port_range:
# required
max: 56
min: 56
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||||
---|---|---|---|---|---|---|
network_security_group_security_rule
complex
|
on success |
Details of the NetworkSecurityGroupSecurityRule resource acted upon by the current operation
Sample:
{'security_rules': [{'description': 'description_example', 'destination': 'destination_example', 'destination_type': 'CIDR_BLOCK', 'direction': 'EGRESS', 'icmp_options': {'code': 56, 'type': 56}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_stateless': True, 'is_valid': True, 'protocol': 'protocol_example', 'source': 'source_example', 'source_type': 'CIDR_BLOCK', 'tcp_options': {'destination_port_range': {'max': 56, 'min': 56}, 'source_port_range': {'max': 56, 'min': 56}}, 'time_created': '2013-10-20T19:20:30+01:00', 'udp_options': {'destination_port_range': {'max': 56, 'min': 56}, 'source_port_range': {'max': 56, 'min': 56}}}]}
|
||||
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` or `2001:0db8:0123:45::/56` IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
* 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 |
|
||||
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:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||||
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` or `2001:0db8:0123:45::/56` IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
* 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 |
|
||||
destination_port_range
complex
|
on success |
|
||||
max
integer
|
on success |
The maximum port number, which must not be less 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, which must not be greater than the maximum port number.
Sample:
56
|
||||
source_port_range
complex
|
on success |
|
||||
max
integer
|
on success |
The maximum port number, which must not be less 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, which 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-20T19:20:30+01:00
|
||||
udp_options
complex
|
on success |
|
||||
destination_port_range
complex
|
on success |
|
||||
max
integer
|
on success |
The maximum port number, which must not be less 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, which must not be greater than the maximum port number.
Sample:
56
|
||||
source_port_range
complex
|
on success |
|
||||
max
integer
|
on success |
The maximum port number, which must not be less 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, which must not be greater than the maximum port number.
Sample:
56
|
Authors¶
Oracle (@oracle)