# How to manage replicators ## View replicators CLI To list all replicators in the current project, run: ```none lxc replicator list ``` To view the configuration for a specific replicator, run: ```none lxc replicator show ``` To view the current state and job information for a specific replicator, run: ```none lxc replicator info ``` API To list all replicators in the current project, send the following request: ```none lxc query --request GET /1.0/replicators?project= ``` To display detailed information about each replicator, use [Recursion](https://canonical.com/lxd/docs/latest/rest-api/index.html.md#rest-api-recursion): ```none lxc query --request GET /1.0/replicators?project=&recursion=1 ``` See [`GET /1.0/replicators`](/lxd/latest/api/#/replicators/replicators_get) and [`GET /1.0/replicators?recursion=1`](/lxd/latest/api/#/replicators/replicators_get_recursion1) for more information. To view the configuration of a specific replicator, send the following request: ```none lxc query --request GET /1.0/replicators/?project= ``` See [`GET /1.0/replicators/{name}`](/lxd/latest/api/#/replicators/replicator_get) for more information. To view the current state and job information for a specific replicator, send the following request: ```none lxc query --request GET /1.0/replicators//state?project= ``` See [`GET /1.0/replicators/{name}/state`](/lxd/latest/api/#/replicators/%7Bname%7D/state/replicator_state_get) for more information. UI Click Clustering in the navigation sidebar, then select Replicators from the expanded drop-down list. To view the configuration for a specific replicator, click on the replicator’s name. ## Configure a replicator See [Replicator configuration](https://canonical.com/lxd/docs/latest/reference/replicator_config/index.html.md#ref-replicator-config) for all available configuration options. CLI To edit the entire configuration of a replicator at once in your default text editor, run: ```none lxc replicator edit ``` You can also update a single configuration option for a replicator: ```none lxc replicator set = ``` To unset a configuration key, run: ```none lxc replicator unset ``` API To edit the entire configuration of a replicator, send the following request: ```none lxc query --request PUT /1.0/replicators/?project= --data "" ``` See [`PUT /1.0/replicators/{name}`](/lxd/latest/api/#/replicators/replicator_put) for more information. You can also update a single configuration option for a replicator: ```none lxc query --request PATCH /1.0/replicators/?project= --data '{"config": {"": ""}}' ``` See [`PATCH /1.0/replicators/{name}`](/lxd/latest/api/#/replicators/replicator_patch) for more information. UI To edit a replicator, click on the pencil icon at the end of that replicator’s row, then set configuration options in the side panel. Alternatively, click on a replicator name to view its detail page, then click on the Edit button in the header. ## Rename a replicator CLI ```none lxc replicator rename ``` API ```none lxc query --request POST /1.0/replicators/?project= --data '{"name": ""}' ``` See [`POST /1.0/replicators/{name}`](/lxd/latest/api/#/replicators/replicator_post) for more information. UI To rename a replicator, click on a replicator name to view its detail page. Then click on the replicator name in the header, enter the new name, and click Save. ## Delete a replicator CLI ```none lxc replicator delete ``` API ```none lxc query --request DELETE /1.0/replicators/?project= ``` See [`DELETE /1.0/replicators/{name}`](/lxd/latest/api/#/replicators/replicator_delete) for more information. UI To delete a replicator, click on the trash can icon at the end of that replicator’s row. Alternatively, click on a replicator name to view its detail page, then click on the Delete button in the header. ## Related topics How-to guides: * [How to set up replicators](https://canonical.com/lxd/docs/latest/howto/replicators_create/index.html.md#howto-replicators-setup) * [How to perform disaster recovery with replicators](https://canonical.com/lxd/docs/latest/howto/disaster_recovery_replicators/index.html.md#howto-replicators-dr) Reference: * [Replicator configuration](https://canonical.com/lxd/docs/latest/reference/replicator_config/index.html.md#ref-replicator-config)