`mongobiuser`¶

On this page

Description
Options
Use

Description¶

mongobiuser¶

Note

The MongoDB Business Intelligence Connector and associated utilities are only available with MongoDB Enterprise.

mongobiuser allows you to create, drop, and list users within a MongoDB Business Intelligence Connector running on the same host.

There must be at least one user created in order for Business Intelligence Connector to function.

mongobiuser has several subcommands that perform different actions:

Command Arguments Description

mongobiuser create

[create-flags] [username] [url]

Creates a new user in the Business Intelligence Connector and associate them with the corresponding MongoDB connection string.

If the MongoDB instance uses Transport Encryption, you must use the ssl=true option allowed in PyMongo connection strings.

mongobiuser drop [username] Delete the given [username] and all data associated with them from the Business Intelligence Connector.

mongobiuser list List all users in the Business Intelligence Connector.

Options¶

Core Options¶

mongobiuser¶

--help¶: Returns information on the options and use of mongobiuser.

--port <port>, -p <port>¶

Default: 27032

Specifies the TCP port on which the Business Intelligence Connector is listening.

Create Options¶

--password <password>, -W <password>¶: Specifies the password that the user being created must use to authenticate with the Business Intelligence Connector. If this option is not specified, mongobiuser will prompt for a password.

Use¶

Create¶

Suppose you have a three-member MongoDB replica set requiring Transport Encryption and authentication with a user brad who has a given password. To associate a Business Intelligence Connector user bradbi with this replica set, you can run the following command:

mongobiuser create bradbi \
            'mongodb://brad:password@localhost:27017,localhost:27018,localhost:27019/?readPreference=secondary&ssl=true'

Drop¶

To delete the user bradbi and all of their tables from the Business Intelligence Connector, you can run the following command:

mongobiuser drop bradbi

List¶

To list all users associated with the Business Intelligence Connector, you can run the following command:

mongobiuser list

mongobiuser¶