/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ /** * A *network security group* (NSG) provides virtual firewall rules for a specific set of * {@link Vnic} in a VCN. Compare NSGs with {@link SecurityList}, * which provide virtual firewall rules to all the VNICs in a *subnet*. *
A network security group consists of two items: *
* The set of {@link 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 {@link 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 * {@link #createVnicDetails(CreateVnicDetailsRequest) createVnicDetails}). Or you can add an existing * instance to an NSG with {@link #updateVnic(UpdateVnicRequest) updateVnic}. *
To add security rules to an NSG, see * {@link #addNetworkSecurityGroupSecurityRules(AddNetworkSecurityGroupSecurityRulesRequest) addNetworkSecurityGroupSecurityRules}. *
To list the VNICs in an NSG, see * {@link #listNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest) listNetworkSecurityGroupVnics}. *
To list the security rules in an NSG, see * {@link #listNetworkSecurityGroupSecurityRules(ListNetworkSecurityGroupSecurityRulesRequest) listNetworkSecurityGroupSecurityRules}. *
For more information about network security groups, see * [Network Security Groups](https://docs.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm). *
**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 {@link 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](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm). * */ export interface NetworkSecurityGroup { /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment the network security group is in. * */ "compartmentId": string; /** * Defined tags for this resource. Each key is predefined and scoped to a * namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. * Avoid entering confidential information. * */ "displayName"?: string; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *
Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security group. */ "id": string; /** * The network security group's current state. */ "lifecycleState": NetworkSecurityGroup.LifecycleState; /** * Usage of system tag keys. These predefined keys are scoped to namespaces. * Example: {@code { \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }} * */ "systemTags"?: { [key: string]: { [key: string]: any; }; }; /** * The date and time the network security group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). *
Example: {@code 2016-08-25T21:10:29.600Z} * */ "timeCreated": Date; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security group's VCN. */ "vcnId": string; } export declare namespace NetworkSecurityGroup { enum LifecycleState { Provisioning = "PROVISIONING", Available = "AVAILABLE", Terminating = "TERMINATING", Terminated = "TERMINATED", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: NetworkSecurityGroup): object; function getDeserializedJsonObj(obj: NetworkSecurityGroup): object; }