Documentation Index
Fetch the complete documentation index at: https://docs.nscale.com/llms.txt
Use this file to discover all available pages before exploring further.
Security groups act as virtual firewalls, controlling inbound and outbound traffic for compute instances.
Aliases: securitygroups, sg
Subcommands
- list — List security groups
- get — Get security group details
- create — Create a new security group
- update — Update an existing security group
- delete — Delete a security group
list
List security groups, optionally filtered by organization, project, network, or region.
nscale securitygroups list [flags]
Flags
| Flag | Description |
|---|
—org string | Organization ID |
—project string | Project ID |
—network string | Network ID |
—region string | Region ID |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq filter for value extraction (see Query output with -q) |
Example
nscale securitygroups list --org <org-id> --region <region-id>
get
Get details for a specific security group.
nscale securitygroups get --id <sg-id> --org <org-id>
Flags
| Flag | Description |
|---|
—id string | Security group ID |
—org string | Organization ID |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq filter for value extraction (see Query output with -q) |
create
Create a new security group. Accepts input from a JSON file or stdin.
nscale securitygroups create [flags]
Flags
| Flag | Description |
|---|
—org string | Organization ID |
-f, —file string | Path to a JSON file |
—stdin | Read JSON from standard input |
—dry-run | Preview the request payload without persisting |
-y, —yes | Automatically confirm creation |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq filter for value extraction (see Query output with -q) |
Examples
nscale securitygroups create --file securitygroup.json
nscale securitygroups create --stdin < securitygroup.json
cat securitygroup.json | nscale securitygroups create --stdin
update
Update an existing security group.
nscale securitygroups update --id <sg-id> [flags]
Flags
| Flag | Description |
|---|
—id string | Security group ID |
—org string | Organization ID |
-f, —file string | Path to a JSON file |
—stdin | Read JSON from standard input |
—dry-run | Preview the request payload without persisting |
-y, —yes | Automatically confirm update |
—json | Emit the full JSON payload (mutually exclusive with -q) |
-q, —query stringArray | jq filter for value extraction (see Query output with -q) |
Examples
nscale securitygroups update --id <sg-id> --file securitygroup.json
nscale securitygroups update --id <sg-id> --stdin < securitygroup.json
cat securitygroup.json | nscale securitygroups update --id <sg-id> --stdin
delete
Delete an existing security group.
nscale securitygroups delete --id <sg-id> --org <org-id> [flags]
Flags
| Flag | Description |
|---|
--id string | Security group ID |
--org string | Organization ID |
--dry-run | Preview the request payload without persisting |
-y, --yes | Automatically confirm deletion |
Instances (Console)
Security groups are configured during instance creation.
