Getting information about a security group

Written by

Yandex Cloud

Updated at November 26, 2024

Management console

CLI

Terraform

API

In the management console, select the folder containing the security group.
Select Virtual Private Cloud.
In the left-hand panel, select Security groups.
Select the security group you need.
The Overview page will display detailed information about the security group.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

View the description of the CLI command to get information about a security group:
```
yc vpc security-group get --help
```

Get information about your security group by specifying its name or ID:

yc vpc security-group get <security_group_name>

Result:

id: enplgn3uok7u********
folder_id: b1go3el0d8fs********
created_at: "2023-03-24T11:56:01Z"
name: default-sg-enpols3n07b8********
description: Default security group for network
network_id: enpols3n07b8********
status: ACTIVE
default_for_network: true

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the documentation on the Terraform website or mirror website.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To get information about a security group using Terraform:

Add the data and output sections to the Terraform configuration file:
```
data "yandex_vpc_security_group" "group1" {
  security_group_id = "<security_group_ID>"
}

output "group" {
  value = data.yandex_vpc_security_group.group1.ingress
}
```
Where:
- data "yandex_vpc_security_group": Description of the security group as a data source:
  - security_group_id: Security group ID.
- output "group": Output variable that contains information about the incoming traffic rules:
  - value: Returned value.
You can replace ingress with any other parameter to get the information you need. For more information about the yandex_vpc_security_group data source parameters, see the relevant provider documentation.
Create resources:
1. In the terminal, change to the folder where you edited the configuration file.
2. Make sure the configuration file is correct using the command:
```
terraform validate
```
  If the configuration is correct, the following message is returned:
```
Success! The configuration is valid.
```
3. Run the command:
```
terraform plan
```
  The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.
4. Apply the configuration changes:
```
terraform apply
```
5. Confirm the changes: type yes in the terminal and press Enter.
Terraform will create the required resources and display the output variable values in the terminal. To check the results, run:
```
terraform output
```
Result:
```
group = toset([
  {
    "description" = ""
    "from_port" = -1
    "id" = "enpt1jlfgv3e*********"
    "labels" = tomap({})
    "port" = 8000
    "predefined_target" = "self_security_group"
    "protocol" = "ANY"
    "security_group_id" = ""
    "to_port" = -1
    "v4_cidr_blocks" = tolist([])
    "v6_cidr_blocks" = tolist([])
  },
])
```

To get detailed information about a security group, use the get REST API method for the SecurityGroup resource or the SecurityGroupService/Get gRPC API call.