mongocli ops-manager admin backup sync describe

On this page

Syntax

Arguments
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 describe command retrieves the configuration of the specified sync store. You can also retrieve the configuration of a sync store using the API.

Syntax

mongocli ops-manager|om admin backup sync describe|get <name>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]

Arguments

Option	Type	Description	Required?
`name`	string	Unique name for the sync store you want to describe. This is also the sync store ID. You can retrieve a list of sync store names for a project with the List Backup Sync Store Configurations command.	yes

Options

Option	Type	Description	Required?
`--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.

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

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.

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 describe command retrieves the configuration of the sync store named test. The command uses the default profile to access Ops Manager.

mongocli om admin backup sync describe test

The previous command returns the following:

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

mongocli om admin backup sync describe test --output json

The previous command returns the following:

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

Back

Create One Backup Sync Configuration

Update One Backup Sync Configuration