OptiTech
    Docs
    Log inBook a demo
    /APIs & SDKs/Organizations and networking/vpc

    OptiTech CLI command: vpc

    Manage Private Networking VPC endpoints and project-level restrictions

    The vpc command manages Private Networking configurations in OptiTech. Use it to register VPC endpoints at the organization level and to restrict individual projects to connections from a specific VPC.

    Subcommands: endpoint, project

    VPC endpoints

    The vpc endpoint subcommands list, assign, remove, and check the status of VPC endpoints for a OptiTech organization.

    Subcommands: assign, list, remove, status

    You only need --org-id if your OptiTech account belongs to more than one organization. If your account has a single organization, the CLI uses it automatically. Instead of passing IDs on each command, you can also set them in a context file and reference it with the --context-file option.

    optitech vpc endpoint list

    Lists the VPC endpoints configured for a OptiTech organization.

    optitech vpc endpoint list [options]
    OptionDescriptionTypeDefaultRequired
    --org-idOrganization IDstring—No
    --region-idThe region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2string—Yes
    optitech vpc endpoint list --org-id org-bold-bonus-12345678

    optitech vpc endpoint assign

    Adds or updates a VPC endpoint in a OptiTech organization. add and update are aliases for this command.

    optitech vpc endpoint assign <id> [options]
    OptionDescriptionTypeDefaultRequired
    --labelAn optional descriptive label for the VPC endpointstring—No
    --org-idOrganization IDstring—No
    --region-idThe region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2string—Yes

    Add a VPC endpoint to a OptiTech organization in a specific region:

    optitech vpc endpoint assign vpce-1234567890abcdef0 --org-id org-bold-bonus-12345678 --region-id aws-us-east-1

    After you assign a VPC endpoint to a OptiTech organization, client connections are accepted from the corresponding VPC for all projects in the organization unless you restrict access at the project level with vpc project restrict.

    optitech vpc endpoint remove

    Removes a VPC endpoint from a OptiTech organization.

    optitech vpc endpoint remove <id> [options]
    OptionDescriptionTypeDefaultRequired
    --org-idOrganization IDstring—No
    --region-idThe region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2string—Yes
    optitech vpc endpoint remove vpce-1234567890abcdef0 --org-id org-bold-bonus-12345678

    note

    A removed VPC endpoint cannot be added back to the OptiTech organization.

    optitech vpc endpoint status

    Gets the status of a VPC endpoint in a OptiTech organization.

    optitech vpc endpoint status <id> [options]
    OptionDescriptionTypeDefaultRequired
    --org-idOrganization IDstring—No
    --region-idThe region ID. Possible values: aws-us-west-2, aws-ap-southeast-1, aws-ap-southeast-2, aws-eu-central-1, aws-us-east-2, aws-us-east-1, azure-eastus2string—Yes
    optitech vpc endpoint status vpce-1234567890abcdef0 --org-id org-bold-bonus-12345678

    Project VPC restrictions

    The vpc project subcommands list, configure, or remove VPC endpoint restrictions for specific projects in your OptiTech organization. By default, a project accepts connections from any VPC configured at the organization level. A restriction limits a project to connections from a specific VPC.

    Subcommands: list, remove, restrict

    You only need --project-id if your OptiTech account has more than one project.

    optitech vpc project list

    Lists all VPC endpoint restrictions for a OptiTech project.

    optitech vpc project list [options]
    OptionDescriptionTypeDefaultRequired
    --project-idProject IDstring—No
    optitech vpc project list --project-id orange-credit-12345678

    optitech vpc project restrict

    Configures or updates a VPC endpoint restriction for a OptiTech project. update is an alias for this command.

    optitech vpc project restrict <id> [options]
    OptionDescriptionTypeDefaultRequired
    --labelAn optional descriptive label for the VPC endpoint restrictionstring—No
    --project-idProject IDstring—No
    optitech vpc project restrict vpce-1234567890abcdef0 --project-id orange-credit-12345678

    optitech vpc project remove

    Removes a VPC endpoint restriction from a OptiTech project.

    optitech vpc project remove <id> [options]
    OptionDescriptionTypeDefaultRequired
    --project-idProject IDstring—No
    optitech vpc project remove vpce-1234567890abcdef0 --project-id orange-credit-12345678
    Was this page helpful?
    Previous ip-allowNext Get started

    On this page

    Copy neon init command