# rubrik\_login\_banner

## rubrik\_login\_banner

Configure the Rubrik cluster login banner text.

`Requirement: Rubrik Python SDK (pip install rubrik_cdm)`

## Example

```yaml
- rubrik_login_banner:
    banner_text: "This is a pre-login Banner. Welcome to Rubrik!"
```

## Arugments

### Common

| Name       | Description                                                                                                                                                                                                                                                                                                  | Default |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| node\_ip   | The DNS hostname or IP address of the Rubrik cluster. By defeault, the module will attempt to read this value from the rubrik\_cdm\_node\_ip environment variable. If this environment variable is not present it will need to be manually specified here or in the \`provider' parameter.                   |         |
| password   | The password used to authenticate the connection to the Rubrik cluster. By defeault, the module will attempt to read this value from the rubrik\_cdm\_password environment variable. If this environment variable is not present it will need to be manually specified here or in the \`provider' parameter. |         |
| username   | The username used to authenticate the connection to the Rubrik cluster. By defeault, the module will attempt to read this value from the rubrik\_cdm\_username environment variable. If this environment variable is not present it will need to be manually specified here or in the \`provider' parameter. |         |
| api\_token | The api token used to authenticate the connection to the Rubrik cluster. By defeault, the module will attempt to read this value from the rubrik\_cdm\_token environment variable. If this environment variable is not present it will need to be manually specified here or in the \`provider' parameter.   |         |
| provider   | Convenience method that allows all connection arguments (`node_ip',`username', \`password') to be passed as a dict object. By default, the module will attempt to read these parameters from the rubrik\_cdm\_node\_ip, rubrik\_cdm\_username, and rubrik\_cdm\_password environment variables.              |         |

| Note: The `username` and `password` must be supplied together and may not be provided if the `api_token` variable is present |
| ---------------------------------------------------------------------------------------------------------------------------- |

### Module Specific

| Name                  | Description                                                                                                  | Default | Type | Choices | Mandatory | Aliases |
| --------------------- | ------------------------------------------------------------------------------------------------------------ | ------- | ---- | ------- | --------- | ------- |
| rubrik\_login\_banner | The Login Banner displayed by the Rubrik cluster to display prior to user login.                             |         | str  |         | true      |         |
| timeout               | The number of seconds to wait to establish a connection the Rubrik cluster before returning a timeout error. | 15      | int  |         |           |         |

## Return Values

| Name     | Description                                                                                                          | Returned                                       | Type   | Aliases |
| -------- | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------ | ------- |
| response | The full API response for PUT /internal/cluster/me/login\_banner                                                     | success                                        | dict   |         |
| response | A "No change required" message when the banner text is identical to that which is already configured on the cluster. | When the module idempotent check is succesful. | string |         |
