{
  "id": "bind",
  "title": "rladmin bind",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/cli-utilities/rladmin/bind/",
  "summary": "Manages the proxy policy for a specified database endpoint.",
  "content": "\nManages the proxy policy for a specific database endpoint.\n\n## `bind endpoint exclude`\n\nDefines 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```sh\nrladmin bind\n        [ db { db:\u003cid\u003e | \u003cname\u003e } ]\n        endpoint \u003cid\u003e exclude\n        \u003cproxy_id1 .. proxy_idN\u003e\n```\n\n### Parameters\n\n| Parameter | Type/Value                     | Description                                                                                   |\n|-----------|--------------------------------|-----------------------------------------------------------------------------------------------|\n| db        | db:\\\u003cid\\\u003e\u003cbr /\u003e 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                                                           |\n\n### Returns\n\nReturns `Finished successfully` if the list of excluded proxies was successfully changed. Otherwise, it returns an error.\n\nUse [`rladmin status endpoints`]() to verify that the policy changed.\n\n### Example\n\n``` sh\n$ 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\n```\n\n## `bind endpoint include`\n\nDefines 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```sh\nrladmin bind\n        [ db { db:\u003cid\u003e | \u003cname\u003e } ]\n        endpoint \u003cid\u003e include\n        \u003cproxy_id1 .. proxy_idN\u003e\n```\n\n### Parameters\n\n| Parameter | Type/Value                     | Description                                                                                   |\n|-----------|--------------------------------|-----------------------------------------------------------------------------------------------|\n| db        | db:\\\u003cid\\\u003e\u003cbr /\u003e 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                                                           |\n\n### Returns\n\nReturns `Finished successfully` if the list of included proxies was successfully changed. Otherwise, it returns an error.\n\nUse [`rladmin status endpoints`]() to verify that the policy changed.\n\n### Example\n\n``` sh\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\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\n```\n\n## `bind endpoint policy`\n\nChanges the overall proxy policy for a specific database endpoint.\n\n```sh\nrladmin bind\n        [ db { db:\u003cid\u003e | \u003cname\u003e } ]\n        endpoint \u003cid\u003e\n        policy { single | all-master-shards | all-nodes }\n```\n\n### Parameters\n\n| Parameter | Type/Value                     | Description                                                                                   |\n|-----------|--------------------------------|-----------------------------------------------------------------------------------------------|\n| db        | db:\\\u003cid\\\u003e\u003cbr /\u003e name           | Only allows endpoints for the specified database                                               |\n| endpoint  | endpoint ID                    | Changes proxy settings for the specified endpoint                              |\n| policy    | \u003cnobr\u003e'all-master-shards'\u003c/nobr\u003e\u003cbr /\u003e \u003cnobr\u003e'all-nodes'\u003c/nobr\u003e\u003cbr /\u003e 'single' | Changes the [proxy policy](#proxy-policies) to the specified policy |\n\n| Proxy\u0026nbsp;policy\u003ca name=\"proxy-policies\"\u003e | 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)               |\n\n### Returns\n\nReturns `Finished successfully` if the proxy policy was successfully changed. Otherwise, it returns an error.\n\nUse [`rladmin status endpoints`]() to verify that the policy changed.\n\n### Example\n\n``` sh\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\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\n```\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}

