Install with Ansible

Legacy 'nms' references Some commands, file paths, and configuration references still use nms due to the ongoing transition from NGINX Management Suite (NMS) to NGINX Instance Manager (NIM). These will be updated in future releases.

Some commands, file paths, and configuration references still use nms due to the ongoing transition from NGINX Management Suite (NMS) to NGINX Instance Manager (NIM). These will be updated in future releases.

Introduction

Introduction

This guide explains how to install F5 NGINX Instance Manager using the open-source Ansible role.

With Ansible, you can automate and replicate your installation across multiple environments.

Open-Source Project on GitHub The steps in this guide refer to the Ansible NGINX Instance Manager Role project on GitHub.

The steps in this guide refer to the Ansible NGINX Instance Manager Role project on GitHub.

---

Overview

Overview

The Ansible role for NGINX Instance Manager simplifies the installation process by installing all the prerequisites and any modules you specify.

---

System requirements

System requirements

• The Ansible role requirements can be viewed on GitHub.

---

Installation steps

Installation steps

1. Install Ansible by following the installation steps on GitHub.

2. Create the inventory file with the details of the host you want to install NGINX Instance Manager on. Make sure you have access to the host. Example here.

3. Create the requirements file and install the required Ansible role by following these steps.

4. Create and run the Ansible playbook. Create a file named nms-playbook.yml (or any other name) with contents similar to the following example:

   yaml

   Copy

   - hosts: nms
     become: yes
     vars:
       nginx_license:
         certificate: ./nginx-repo.crt
         key: ./nginx-repo.key
       nms_setup: install
       nms_version: 2.16.0*
       nms_user_name: admin
       nms_user_passwd: default
       nms_modules:
         - name: sm
     collections:
       - nginxinc.nginx_core
     roles:
       - nginxinc.nginx_management_suite

   - hosts: nms
     become: yes
     vars:
       nginx_license:
         certificate: ./nginx-repo.crt
         key: ./nginx-repo.key
       nms_setup: install
       nms_version: 2.16.0*
       nms_user_name: admin
       nms_user_passwd: default
       nms_modules:
         - name: sm
     collections:
       - nginxinc.nginx_core
     roles:
       - nginxinc.nginx_management_suite

5. Run the playbook:

   Copy

   ansible-playbook -i <path-to-your-hostfile> nms-playbook.yml

   ansible-playbook -i <path-to-your-hostfile> nms-playbook.yml

See Also: For a comprehensive list of configuration options, view the default main.yaml file on GitHub.

For a comprehensive list of configuration options, view the default main.yaml file on GitHub.

---

Getting support

Getting support

If you need help or have questions, you can request support from the NGINX Instance Manager Ansible Role Project on GitHub.

---

---