oracle.oci.oci_network_firewall – Manage a NetworkFirewall resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_firewall
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a NetworkFirewall resource in Oracle Cloud Infrastructure
For state=present, creates a new NetworkFirewall.
This resource has the following action operations in the oracle.oci.oci_network_firewall_actions module: change_compartment.
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 |
---|---|---|
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. |
availability_domain
string
|
Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: `kIdk:PHX-AD-1`
|
|
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.
|
|
compartment_id
string
|
The OCID of the compartment containing the Network Firewall.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|
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 . |
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
|
display_name
string
|
A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
freeform_tags
dictionary
|
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
|
|
ipv4_address
string
|
IPv4 address for the Network Firewall.
|
|
ipv6_address
string
|
IPv6 address for the Network Firewall.
|
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|
network_firewall_id
string
|
The OCID of the Network Firewall resource.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|
network_firewall_policy_id
string
|
The OCID of the Network Firewall Policy.
Required for create using state=present.
This parameter is updatable.
|
|
network_security_group_ids
list
/ elements=string
|
An array of network security groups OCID associated with the Network Firewall.
This parameter is updatable.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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. |
|
state
string
|
|
The state of the NetworkFirewall.
Use state=present to create or update a NetworkFirewall.
Use state=absent to delete a NetworkFirewall.
|
subnet_id
string
|
The OCID of the subnet associated with the Network Firewall.
Required for create using state=present.
|
|
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 |
|
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create network_firewall
oci_network_firewall:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
network_firewall_policy_id: "ocid1.networkfirewallpolicy.oc1..xxxxxxEXAMPLExxxxxx"
# optional
availability_domain: Uocm:PHX-AD-1
ipv4_address: ipv4_address_example
ipv6_address: ipv6_address_example
display_name: display_name_example
network_security_group_ids: [ "network_security_group_ids_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update network_firewall
oci_network_firewall:
# required
network_firewall_id: "ocid1.networkfirewall.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
network_firewall_policy_id: "ocid1.networkfirewallpolicy.oc1..xxxxxxEXAMPLExxxxxx"
network_security_group_ids: [ "network_security_group_ids_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update network_firewall using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_firewall:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
network_firewall_policy_id: "ocid1.networkfirewallpolicy.oc1..xxxxxxEXAMPLExxxxxx"
network_security_group_ids: [ "network_security_group_ids_example" ]
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete network_firewall
oci_network_firewall:
# required
network_firewall_id: "ocid1.networkfirewall.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete network_firewall using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_firewall:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
network_firewall
complex
|
on success |
Details of the NetworkFirewall resource acted upon by the current operation
Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ipv4_address': 'ipv4_address_example', 'ipv6_address': 'ipv6_address_example', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'network_firewall_policy_id': 'ocid1.networkfirewallpolicy.oc1..xxxxxxEXAMPLExxxxxx', 'network_security_group_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
|
|
availability_domain
string
|
on success |
Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use ListAvailabilityDomains operation. Example: `kIdk:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
|
compartment_id
string
|
on success |
The OCID of the compartment containing the Network Firewall.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
display_name
string
|
on success |
A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
|
freeform_tags
dictionary
|
on success |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
|
id
string
|
on success |
The OCID of the Network Firewall resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
ipv4_address
string
|
on success |
IPv4 address for the Network Firewall.
Sample:
ipv4_address_example
|
|
ipv6_address
string
|
on success |
IPv6 address for the Network Firewall.
Sample:
ipv6_address_example
|
|
lifecycle_details
string
|
on success |
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
Sample:
lifecycle_details_example
|
|
lifecycle_state
string
|
on success |
The current state of the Network Firewall.
Sample:
CREATING
|
|
network_firewall_policy_id
string
|
on success |
The OCID of the Network Firewall Policy.
Sample:
ocid1.networkfirewallpolicy.oc1..xxxxxxEXAMPLExxxxxx
|
|
network_security_group_ids
list
/ elements=string
|
on success |
An array of network security groups OCID associated with the Network Firewall.
|
|
subnet_id
string
|
on success |
The OCID of the subnet associated with the Network Firewall.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
|
system_tags
dictionary
|
on success |
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
|
|
time_created
string
|
on success |
The time instant at which the Network Firewall was created in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
|
time_updated
string
|
on success |
The time instant at which the Network Firewall was updated in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)