mongocli ops-manager admin backup sync list

On this page

Syntax

Options
Output
Example

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoCLI.

Note

You must be a Global Owner to run admin commands.

The admin backup sync list command retrieves all configured sync stores. You can also retrieve the configurations of all sync stores using the API.

Syntax

mongocli ops-manager|om admin backup sync list|ls
     [ --limit <items-per-page> ]
     [ --page <page-number> ]
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]

Note

Use -h or --help to view the command-line help for this command.

Options

Option	Type	Description	Required?
`--limit`	integer	Number of items to return per page, up to a maximum of 500. Defaults to `100` if omitted.	no
`--page`	integer	Page number (1-based). Defaults to `1` if not specified.	no
`--output`, `-o`	string	Command output format. Valid values are: `json` for output in JSON format `go-template` for custom output using the Go template `go-template-file` for custom output specified using Go template file If omitted, the command returns output in the default format.	no
`--profile`, `-P`	string	Name of the profile where the public and private keys for accessing Ops Manager are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.	no

Output

The command prints the following fields in the specified format to the terminal if the command succeeds. If the command prints an error, see Troubleshooting for recommended solutions.

Sync configuration '<name>' updated.

The default output contains a subset of the fields returned by this command. For the complete list of JSON fields returned by the command, see the API reference.

Example

The following mongocli om admin backup sync list command retrieves the configurations of all sync stores. The command uses the default profile, which contains credentials to access Ops Manager.

mongocli om admin backup sync list

The previous command returns the following:

NAME    URI                         SSL     LOAD FACTOR
sync1   mongodb://localhost:27017   false   1

mongocli om admin backup sync list --output json

The previous command returns the following:

{
  "name": "sync1",
  "uri": "mongodb://localhost:27017",
  "ssl": false,
  "loadFactor": 1
 }

Back

Sync Store Configurations

Create One Backup Sync Configuration