{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/rladmin/bind",
  "title": "rladmin bind",
  "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/bind/",
  "summary": "Manages the proxy policy for a specified database endpoint.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2026-09-24T10:14:21+01:00",
  "page_type": "content",
  "content_hash": "20dfd8ddd3e6548b4c22b13c8f4a770042440e22137bd9bd5a00247191efa183",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Manages the proxy policy for a specific database endpoint."
    },
    {
      "id": "bind-endpoint-exclude",
      "title": "`bind endpoint exclude`",
      "role": "content",
      "text": "Defines a list of nodes to exclude from the proxy policy for a specific database endpoint. When you exclude a node, the endpoint cannot bind to the node's proxy.\n\nEach time you run an exclude command, it overwrites the previous list of excluded nodes.\n\n[code example]"
    },
    {
      "id": "parameters",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter | Type/Value                     | Description                                                                                   |\n|-----------|--------------------------------|-----------------------------------------------------------------------------------------------|\n| db        | db:\\<id\\><br /> name           | Only allows endpoints for the specified database                                               |\n| endpoint  | endpoint ID                    | Changes proxy settings for the specified endpoint                              |\n| proxy     | list of proxy IDs          | Proxies to exclude                                                           |"
    },
    {
      "id": "returns",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `Finished successfully` if the list of excluded proxies was successfully changed. Otherwise, it returns an error.\n\nUse [`rladmin status endpoints`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/status#status-endpoints) to verify that the policy changed."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "bind-endpoint-include",
      "title": "`bind endpoint include`",
      "role": "content",
      "text": "Defines a list of nodes to include in the proxy policy for the specific database endpoint.\n\nEach time you run an include command, it overwrites the previous list of included nodes.\n\n[code example]"
    },
    {
      "id": "parameters-1",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter | Type/Value                     | Description                                                                                   |\n|-----------|--------------------------------|-----------------------------------------------------------------------------------------------|\n| db        | db:\\<id\\><br /> name           | Only allows endpoints for the specified database                                               |\n| endpoint  | endpoint ID                    | Changes proxy settings for the specified endpoint                              |\n| proxy     | list of proxy IDs          | Proxies to include                                                           |"
    },
    {
      "id": "returns-1",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `Finished successfully` if the list of included proxies was successfully changed. Otherwise, it returns an error.\n\nUse [`rladmin status endpoints`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/status#status-endpoints) to verify that the policy changed."
    },
    {
      "id": "example-1",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "bind-endpoint-policy",
      "title": "`bind endpoint policy`",
      "role": "content",
      "text": "Changes the overall proxy policy for a specific database endpoint.\n\n[code example]"
    },
    {
      "id": "parameters-2",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter | Type/Value                     | Description                                                                                   |\n|-----------|--------------------------------|-----------------------------------------------------------------------------------------------|\n| db        | db:\\<id\\><br /> name           | Only allows endpoints for the specified database                                               |\n| endpoint  | endpoint ID                    | Changes proxy settings for the specified endpoint                              |\n| policy    | <nobr>'all-master-shards'</nobr><br /> <nobr>'all-nodes'</nobr><br /> 'single' | Changes the [proxy policy](#proxy-policies) to the specified policy |\n\n| Proxy&nbsp;policy<a name=\"proxy-policies\"> | Description |\n| - | - |\n| all-master-shards | Multiple proxies, one on each master node (best for high traffic and multiple master shards)                     |\n| all-nodes | Multiple proxies, one on each node of the cluster (increases traffic in the cluster, only used in special cases) |\n| single | All traffic flows through a single proxy bound to the database endpoint (preferable in most cases)               |"
    },
    {
      "id": "returns-2",
      "title": "Returns",
      "role": "returns",
      "text": "Returns `Finished successfully` if the proxy policy was successfully changed. Otherwise, it returns an error.\n\nUse [`rladmin status endpoints`](https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/status#status-endpoints) to verify that the policy changed."
    },
    {
      "id": "example-2",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "bind-endpoint-exclude-ex0",
      "language": "sh",
      "code": "rladmin bind\n        [ db { db:<id> | <name> } ]\n        endpoint <id> exclude\n        <proxy_id1 .. proxy_idN>",
      "section_id": "bind-endpoint-exclude"
    },
    {
      "id": "example-ex0",
      "language": " sh",
      "code": "$ rladmin status endpoints db db:6\nENDPOINTS:\nDB:ID    NAME   ID                  NODE      ROLE                      SSL\ndb:6     tr02   endpoint:6:1        node:2    all-nodes                 No\ndb:6     tr02   endpoint:6:1        node:1    all-nodes                 No\ndb:6     tr02   endpoint:6:1        node:3    all-nodes                 No\n$ rladmin bind endpoint 6:1 exclude 2\nExecuting bind endpoint: OOO.\nFinished successfully\n$ rladmin status endpoints db db:6\nENDPOINTS:\nDB:ID    NAME   ID                 NODE      ROLE                       SSL\ndb:6     tr02   endpoint:6:1       node:1    all-nodes -2               No\ndb:6     tr02   endpoint:6:1       node:3    all-nodes -2               No",
      "section_id": "example"
    },
    {
      "id": "bind-endpoint-include-ex0",
      "language": "sh",
      "code": "rladmin bind\n        [ db { db:<id> | <name> } ]\n        endpoint <id> include\n        <proxy_id1 .. proxy_idN>",
      "section_id": "bind-endpoint-include"
    },
    {
      "id": "example-1-ex0",
      "language": " sh",
      "code": "$ rladmin status endpoints db db:6\nENDPOINTS:\nDB:ID    NAME   ID                 NODE      ROLE                       SSL\ndb:6     tr02   endpoint:6:1       node:3    all-master-shards          No\n$ rladmin bind endpoint 6:1 include 3\nExecuting bind endpoint: OOO.\nFinished successfully\n$ rladmin status endpoints db db:6\nENDPOINTS:\nDB:ID   NAME   ID                NODE      ROLE                          SSL\ndb:6    tr02   endpoint:6:1      node:1    all-master-shards +3          No\ndb:6    tr02   endpoint:6:1      node:3    all-master-shards +3          No",
      "section_id": "example-1"
    },
    {
      "id": "bind-endpoint-policy-ex0",
      "language": "sh",
      "code": "rladmin bind\n        [ db { db:<id> | <name> } ]\n        endpoint <id>\n        policy { single | all-master-shards | all-nodes }",
      "section_id": "bind-endpoint-policy"
    },
    {
      "id": "example-2-ex0",
      "language": " sh",
      "code": "$ rladmin status endpoints db db:6\nENDPOINTS:\nDB:ID    NAME   ID                 NODE      ROLE                       SSL\ndb:6     tr02   endpoint:6:1       node:1    all-nodes -2               No\ndb:6     tr02   endpoint:6:1       node:3    all-nodes -2               No\n$ rladmin bind endpoint 6:1 policy all-master-shards\nExecuting bind endpoint: OOO.\nFinished successfully\n$ rladmin status endpoints db db:6\nENDPOINTS:\nDB:ID    NAME   ID                 NODE      ROLE                       SSL\ndb:6     tr02   endpoint:6:1       node:3    all-master-shards          No",
      "section_id": "example-2"
    }
  ]
}