mongocli ops-manager admin backup oplog 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 oplog describe command retrieves the configuration of one oplog store. You can also retrieve the configuration of one oplog store using the API.

Syntax

mongocli ops-manager|om admin backup oplog(s) describe|get <oplog-id>
     [ --output|-o <output-format> ]
     [ --profile|-P <profile-name> ]

Note

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

Arguments

Argument	Type	Description	Required?
`<oplog-id>`	string	Unique identifier of the oplog store that you want to describe. You can retrieve a list of oplog store IDs for a project with the List Backup Oplog 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

If the command succeeds, it returns the following output in the default format. If the command returns errors, see Troubleshooting for recommended solutions.

NAME         URI              SSL              LOAD FACTOR      MAX CAPACITY GB
<oplog-ID>   <store-path>     <true|false>     <load-factor>    <capacity>

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 oplog describe command retrieves the configuration of the oplog store whose ID is oplog1 using the default profile, which contains Ops Manager credentials.

mongocli om admin backup oplog describe oplog1

The previous command returns the following:

NAME     URI                         SSL     LOAD FACTOR   MAX CAPACITY GB
oplog1   mongodb://localhost:27017   false   1             <nil>

mongocli om admin backup oplog describe oplog1 --output json

The previous command returns the following:

{
  "id": "oplog1",
  "uri": "mongodb://localhost:27017",
  "ssl": false,
  "assignmentEnabled": true,
  "encryptedCredentials": false,
  "loadFactor": 1
}

Back

List Backup Oplog Store Configurations

Create One Backup Oplog Store Configuration