mongocli ops-manager featurePolicies update

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.

The featurePolicies update command updates all Ops Manager feature policies for the external system that manages the specified project. You can also update all feature policies for one project through the API.

Syntax

mongocli ops-manager|om featurePolicies update|updates
     --name <name-of-external-system>
   [ --output|-o <output-format> ]
     --policy <one-or-more-feature-policies>
   [ --profile|-P <profile-name> ]
     --projectId <project-ID>
   [ --systemId <id-of-external-system> ]

Note

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

Options

Option

Type

Description

Required?

--name

string

Name of the external system that manages this project's deployment.

yes

--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.

--policy

strings

Comma-separated list of policies that the external system applies to this project. Possible values and their descriptions are:

Variable	Description
`EXTERNALLY_MANAGED_LOCK`	Users can't use Cloud Manager or Ops Manager to manage other settings given in the `policies` list, and may use a configured external system to manage these settings.
`DISABLE_USER_MANAGEMENT`	Users can't manage users or roles.
`DISABLE_AUTHENTICATION_MECHANISMS`	Users can't change authentication settings.
`DISABLE_SET_MONGOD_CONFIG`	Users can't change any `mongod` settings listed in the `policies[n].disabledParams` policy.
`DISABLE_SET_MONGOD_VERSION`	Users can't change the version of any `mongod` or `mongos`.
`DISABLE_BACKUP_AGENT`	Users can't enable or disable the agent.
`DISABLE_MONGOD_LOG_MANAGEMENT`	Users can't change log management settings.
`DISABLE_IMPORT_TO_AUTOMATION`	Users can't manage deployments using Automation Agent.
`DISABLE_AGENT_API_KEY_MANAGEMENT`	Users can't create or update Agent API keys.
`DISABLE_MONGOD_HOST_MANAGEMENT`	Users can't change the server type of hosts.

yes

--profile, -P

string

Name of the profile where the project ID and the Programmatic API Keys for the project are saved. If omitted, uses the default profile. To learn more about creating a profile, see Configure the MongoDB CLI.

--projectId

string

Unique identifier of the project. If omitted, uses the project ID in the profile or environment variable.

--systemId

string

Unique identifier of the external system that manages this Ops Manager project.

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.

Feature control policies updated.

If you request output in JSON format, the command returns the fields described in the API reference.

Example

The following example uses the mongocli om featurePolicies update command to update all feature control policies for the project specified in the profile called myOm.

mongocli om featurePolicies update --name my-external-system --policy EXTERNALLY_MANAGED_LOCK -P myOm

The previous command produces the following output.

Feature control policies updated.

mongocli om featurePolicies update --name my-external-system --policy EXTERNALLY_MANAGED_LOCK -P myOm --output json

The previous command produces the following output.

{
  "created": "2021-01-22T15:10:39Z",
  "updated": "2021-01-23T03:25:40Z",
  "externalManagementSystem": {
     "name": "my-external-system"
},
  "policies": [
    {
    "policy": "EXTERNALLY_MANAGED_LOCK"
    }
  ]
}

Back

List Feature Policies

Logs