# rubrik\_bootstrap

## rubrik\_bootstrap

Issues a bootstrap request to a specified Rubrik cluster

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

## Example

```yaml
vars:
  node_config:
    1: 10.255.1.5

rubrik_bootstrap:
  cluster_name: "Ansible Demo"
  admin_email: "ansiblebuild@rubrik.com"
  admin_password: "AnsibleAndRubrikPassword"
  management_gateway: "10.255.1.1"
  management_subnet_mask: "255.255.255.0"
  enable_encryption: True
  dns_search_domains: ["rubrikansible.com"]
  wait_for_completion: True
  node_config: "{{ node_config }}"
```

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

### Module Specific

| Name                     | Description                                                                                                  | Default           | Type   | Choices | Mandatory | Aliases |
| ------------------------ | ------------------------------------------------------------------------------------------------------------ | ----------------- | ------ | ------- | --------- | ------- |
| admin\_email             | The Rubrik cluster sends messages for the admin account to this email address.                               |                   | string |         | true      |         |
| admin\_password          | Password for the admin account.                                                                              |                   | string |         | true      |         |
| cluster\_name            | Unique name to assign to the Rubrik cluster.                                                                 |                   | string |         | true      |         |
| dns\_nameservers         | IPv4 addresses of DNS servers                                                                                | \['8.8.8.8']      | list   |         |           |         |
| dns\_search\_domains     | The search domain that the DNS Service will use to resolve hostnames that are not fully qualified.           | \[]               | list   |         |           |         |
| enable\_encryption       | Enable software data encryption at rest. When bootstraping a Cloud Cluster this value needs to be False.     | True              | bool   |         |           |         |
| management\_gateway      | IP address assigned to the management network gateway                                                        |                   | string |         | true      |         |
| management\_subnet\_mask | Subnet mask assigned to the management network.                                                              |                   | string |         | true      |         |
| node\_config             | The Node Name and IP formatted as a dictionary                                                               |                   | dict   |         | true      |         |
| ntp\_servers             | FQDN or IPv4 address of a network time protocol (NTP) server.                                                | \['pool.ntp.org'] | list   |         |           |         |
| wait\_for\_completion    | Flag to determine if the function should wait for the bootstrap process to complete.                         | True              | bool   |         |           |         |
| timeout                  | The number of seconds to wait to establish a connection the Rubrik cluster before returning a timeout error. | 30                | int    |         |           |         |

## Return Values

| Name     | Description                                                    | Returned | Type |
| -------- | -------------------------------------------------------------- | -------- | ---- |
| response | The full API response for POST /internal/cluster/me/bootstrap. | success  | dict |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rubrik.gitbook.io/rubrik-modules-for-ansible/modules/rubrik_bootstrap.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.