{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/rladmin/suffix",
  "title": "rladmin suffix",
  "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/suffix/",
  "summary": "Manages the DNS suffixes in the cluster.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2023-12-14T15:27:49+01:00",
  "page_type": "content",
  "content_hash": "b01b6c30bc1c7c89678a32971809ab386902091b7261eeda18ad2c9be5e8e084",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Manages the DNS suffixes in the cluster."
    },
    {
      "id": "suffix-add",
      "title": "`suffix add`",
      "role": "content",
      "text": "Adds a DNS suffix to the cluster.\n\n[code example]"
    },
    {
      "id": "parameters",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter | Type/Value       | Description                                                                                   |\n|-----------|------------------|-----------------------------------------------------------------------------------------------|\n| name      | string           | DNS suffix to add to the cluster                                                             |\n| default   |                  | Sets the given suffix as the default. If a default already exists, this overwrites it.  |\n| internal  |                  | Forces the given suffix to use private IPs                                                    |\n| mdns      |                  | Activates multicast DNS support for the given suffix                                           |\n| slaves    | list of IPv4 addresses | The given suffix will notify the frontend DNS servers when a change in the frontend DNS has occurred |\n| use_aaaa_ns |                | Activates IPv6 address support |"
    },
    {
      "id": "returns",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `Added suffixes successfully` if the suffix was added. Otherwise, it returns an error."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "suffix-delete",
      "title": "`suffix delete`",
      "role": "content",
      "text": "Deletes an existing DNS suffix from the cluster.\n\n[code example]"
    },
    {
      "id": "parameters-1",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter | Type/Value       | Description                                                                                   |\n|-----------|------------------|-----------------------------------------------------------------------------------------------|\n| name      | string           | DNS suffix to delete from the cluster                                                         |"
    },
    {
      "id": "returns-1",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `Suffix deleted successfully` if the suffix was deleted. Otherwise, it returns an error."
    },
    {
      "id": "example-1",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "suffix-list",
      "title": "`suffix list`",
      "role": "content",
      "text": "Lists the DNS suffixes in the cluster.\n\n[code example]"
    },
    {
      "id": "parameters-2",
      "title": "Parameters",
      "role": "parameters",
      "text": "None"
    },
    {
      "id": "returns-2",
      "title": "Returns",
      "role": "returns",
      "text": "Returns a list of the DNS suffixes."
    },
    {
      "id": "example-2",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "suffix-add-ex0",
      "language": " sh",
      "code": "rladmin suffix add name <name>\n        [default]\n        [internal]\n        [mdns]\n        [use_aaaa_ns]\n        [slaves <ip>..]",
      "section_id": "suffix-add"
    },
    {
      "id": "example-ex0",
      "language": " sh",
      "code": "$ rladmin suffix add name new.rediscluster.local\nAdded suffixes successfully",
      "section_id": "example"
    },
    {
      "id": "suffix-delete-ex0",
      "language": " sh",
      "code": "rladmin suffix delete name <name>",
      "section_id": "suffix-delete"
    },
    {
      "id": "example-1-ex0",
      "language": " sh",
      "code": "$ rladmin suffix delete name new.rediscluster.local\nSuffix deleted successfully",
      "section_id": "example-1"
    },
    {
      "id": "suffix-list-ex0",
      "language": "sh",
      "code": "rladmin suffix list",
      "section_id": "suffix-list"
    },
    {
      "id": "example-2-ex0",
      "language": " sh",
      "code": "$ rladmin suffix list\nList of all suffixes:\ncluster.local\nnew.rediscluster.local",
      "section_id": "example-2"
    }
  ]
}