oci core network security group

Overview

A network security group (NSG) provides virtual firewall rules for a specific set of {Vnic} in a VCN. Compare NSGs with {SecurityList}, which provide virtual firewall rules to all the VNICs in a subnet.

A network security group consists of two items:

• The set of {Vnic} that all have the same security rule needs (for example, a group of Compute instances all running the same application)
• A set of NSG {SecurityRule} that apply to the VNICs in the group

After creating an NSG, you can add VNICs and security rules to it. For example, when you create an instance, you can specify one or more NSGs to add the instance to (see {#create_vnic_details create_vnic_details}). Or you can add an existing instance to an NSG with {#update_vnic update_vnic}.

To add security rules to an NSG, see {#add_network_security_group_security_rules add_network_security_group_security_rules}.

To list the VNICs in an NSG, see {#list_network_security_group_vnics list_network_security_group_vnics}.

To list the security rules in an NSG, see {#list_network_security_group_security_rules list_network_security_group_security_rules}.

For more information about network security groups, see Network Security Groups.

Important: Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure all of the following are set correctly:

• Any security rules in any NSGs the instance’s VNIC belongs to
• Any {SecurityList} associated with the instance’s subnet
• The instance’s OS firewall rules

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Here is an example on how to use this:

oci_core_network_security_group { 'tenant (root)/my_security_group':
  ensure      => 'present',
  vcn         => 'my_compartment/my_vcn',
}

This documentation is generated from the Ruby OCI SDK.

Attributes

absent_states

The OCI states, puppet will detect as the resource being absent.

Back to overview of oci_core_network_security_group

compartment

The Puppet® name of the resource identified by compartment_id.

See the documentation of compartment_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group

compartment_id

The OCID of the compartment that contains the object.

Rather use the property compartment instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group

defined_tags

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group

disable_corrective_change

Disable the modification of a resource when Puppet® decides it is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet® Server, Puppet® knows about adaptive and corrective changes. A corrective change is when Puppet® notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet® is managing. The normal Puppet® process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet® cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ...
  disable_corrective_change => true,
  ...
}

When a corrective ensure does happen on the resource Puppet® will not modify the resource and signal an error:

    Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)

Back to overview of oci_core_network_security_group

disable_corrective_ensure

Disable the creation or removal of a resource when Puppet® decides is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet® Server, Puppet® knows about adaptive and corrective changes. A corrective change is when Puppet® notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet® is managing. The normal Puppet® process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet® cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ensure                    => 'present',
  ...
  disable_corrective_ensure => true,
  ...
}

When a corrective ensure does happen on the resource Puppet® will not create or remove the resource and signal an error:

    Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)

Back to overview of oci_core_network_security_group

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of oci_core_network_security_group

freeform_tags

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group

id

The OCID of the resource. This is a read-only property.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group

lifecycle_state

The network security group’s current state.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group

name

The full name of the object.

Back to overview of oci_core_network_security_group

network_security_group_name

The name of the network_security_group.

Back to overview of oci_core_network_security_group

oci_timeout

The maximum time to wait for the OCI resource to be in the ready state.

Back to overview of oci_core_network_security_group

oci_wait_interval

The interval beween calls to OCI to check if a resource is in the ready state.

Back to overview of oci_core_network_security_group

present_states

The OCI states, puppet will detect as the resource being present.

Back to overview of oci_core_network_security_group

provider

The specific backend to use for this oci_core_network_security_group resource. You will seldom need to specify this — Puppet® will usually discover the appropriate provider for your platform.Available providers are:

sdk

This provider uses the Oracle Ruby OCI SDK to do its work.

Back to overview of oci_core_network_security_group

synchronized

Specifies if Puppet® waits for OCI actions to be ready before moving on to an other resource.

Back to overview of oci_core_network_security_group

tenant

The tenant for this resource.

Back to overview of oci_core_network_security_group

time_created

The date and time the network security group was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group

vcn

The Puppet® name of the resource identified by vcn_id.

See the documentation of vcn_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group

vcn_id

The OCID of the VCN to create the network security group in. Rather use the property vcn instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_core_network_security_group