yc smartwebsecurity load-balancer domain update

Flag

Description

--update-mask

[]string

Field paths for FieldMask: each segment may be proto snake_case or CLI kebab-case (e.g. name, labels, network-interface). Repeat the flag or use comma-separated values. When set and non-empty, takes precedence over update_mask in the request body/file and over mask inferred from -r. If omitted or empty, the mask is built from the fields you pass (changed flags, JSON/shorthand, and request file when update_mask is absent there).

--load-balancer-id

string

ID of the Load balancer that the domain belongs to.

--name

string

Name of domain that is being updated.

--server-name

string

Server name or wildcard to be matched against SNI in a TLS connection and authority(host) header. Wildcards are in the form of ".s.o.m.e". Allowed: "example.com", ".example.com". Not allowed: "..example.com", "*-sub.example.com".

--description

string

Domain description

--security-profile-id

string

Security Profile ID of SmartWebSecurity service.

--http-backend

shorthand/json

Backend settings.

{
  idle-timeout = duration,
  session-affinity = {
    session-affinity = connection={
      source-ip = boolean
    } | cookie={
      name = string,
      path = string,
      ttl = duration
    } | header={
      header-name = string
    }
  },
  sni = string,
  targets = [
    {
      description = string,
      ip-address = string,
      port = integer
    }, ...
  ],
  timeout = duration,
  trusted-ca-bytes = string,
  use-http2 = boolean,
  use-tls = boolean
}

{
  "idle-timeout": "duration",
  "session-affinity": {
    "session-affinity": {
      "connection": {
        "source-ip": "boolean"
      },
      "cookie": {
        "name": "string",
        "path": "string",
        "ttl": "duration"
      },
      "header": {
        "header-name": "string"
      }
    }
  },
  "sni": "string",
  "targets": [
    {
      "description": "string",
      "ip-address": "string",
      "port": "integer"
    }, ...
  ],
  "timeout": "duration",
  "trusted-ca-bytes": "string",
  "use-http2": "boolean",
  "use-tls": "boolean"
}

--tls-listener

shorthand/json

Optional TLS listener settings.

{
  certificate-id = string,
  enable-http1 = boolean,
  enabled = boolean,
  port = integer
}

{
  "certificate-id": "string",
  "enable-http1": "boolean",
  "enabled": "boolean",
  "port": "integer"
}

--http-listener

shorthand/json

Optional plaintext listener settings.

{
  enabled = boolean,
  port = integer,
  redirect-to-https = boolean
}

{
  "enabled": "boolean",
  "port": "integer",
  "redirect-to-https": "boolean"
}

--solid-waf-settings

shorthand/json

Optional Solid WAF settings.

{
  session-affinity = {
    session-affinity = connection={
      source-ip = boolean
    } | cookie={
      name = string,
      path = string,
      ttl = duration
    } | header={
      header-name = string
    }
  },
  solid-waf-profile-id = string
}

{
  "session-affinity": {
    "session-affinity": {
      "connection": {
        "source-ip": "boolean"
      },
      "cookie": {
        "name": "string",
        "path": "string",
        "ttl": "duration"
      },
      "header": {
        "header-name": "string"
      }
    }
  },
  "solid-waf-profile-id": "string"
}

--rate-limit

shorthand/json

Optional rate limit settings.

{
  all-requests-per-second = integer,
  requests-per-ip-per-second = integer
}

{
  "all-requests-per-second": "integer",
  "requests-per-ip-per-second": "integer"
}

--async

Display information about the operation in progress, without waiting for the operation to complete.

-r, --request-file

string

Path to a request file.

--example-json

Generates a JSON template of the request.

-e, --example-yaml

Generates a YAML template of the request.

The template can be customized and used as input for the command.

Usage example:

1. Generate template:
   yc smartwebsecurity load-balancer domain update --example-json > request.json
   or
   yc smartwebsecurity load-balancer domain update --example-yaml > request.yaml

2. Edit the template file

3. Run with template:
   yc smartwebsecurity load-balancer domain update -r request.json
   or
   yc smartwebsecurity load-balancer domain update -r request.yaml

Flag

Description

--profile

string

Set the custom profile.

--region

string

Set the region.

--debug

Debug logging.

--debug-grpc

Debug gRPC logging. Very verbose, used for debugging connection problems.

--no-user-output

Disable printing user intended output to stderr.

--pager

string

Set the custom pager.

--no-pager

Do not pipe help output through a pager.

--format

string

Set the output format: text, yaml, json, table, summary || summary[name, instance.id, instance.disks[0].size].

--retry

int

Enable gRPC retries. By default, retries are enabled with maximum 5 attempts.
Pass 0 to disable retries. Pass any negative value for infinite retries.
Even infinite retries are capped with 2 minutes timeout.

--timeout

string

Set the timeout.

--token

string

Set the IAM token to use.

--impersonate-service-account-id

string

Set the ID of the service account to impersonate.

--no-browser

Disable opening browser for authentication.

--query

string

Query to select values from the response using jq syntax

--print-metadata

Print operation metadata along with result.

--syntax

string

Choose syntax option.

--cli-auto-prompt

string[="on"]

Enable interactive auto-prompt mode. Values: on, partial, off. Bare --cli-auto-prompt is equivalent to --cli-auto-prompt=on.

--no-cli-auto-prompt

Disable interactive auto-prompt mode (overrides --cli-auto-prompt, env and profile).

-h, --help

Display help for the command.