Ansible for NSX-T

Overview

This repository contains NSX-T Ansible Modules, which one can use with Ansible to work with VMware NSX-T Data Center and configure for Enterprise PKS.

For general information about Ansible, visit the GitHub project page.

These modules are maintained by VMware.

Documentation on the NSX platform can be found at the NSX-T Documentation page

Supported NSX Objects/Workflows

The modules in this repository are focused on enabling automation of installation workflows of NSX-T.

Branch Information

This repository has a specific NSX-T release. Below is the list:

v1.1.0: NSX-T 2.5.1

Deployment and installation modules

nsxt_deploy_ova
nsxt_licenses
nsxt_manager_status
nsxt_licenses_facts
nsxt_edge_clusters
nsxt_edge_clusters_facts
nsxt_fabric_compute_managers
nsxt_fabric_compute_managers_facts
nsxt_fabric_nodes
nsxt_fabric_nodes_facts
nsxt_compute_collection_fabric_templates
nsxt_compute_collection_fabric_templates_facts
nsxt_ip_pools
nsxt_ip_pools_facts
nsxt_uplink_profiles
nsxt_uplink_profiles_facts
nsxt_transport_zones
nsxt_transport_zones_facts
nsxt_transport_nodes
nsxt_transport_nodes_facts
nsxt_transport_node_collections
nsxt_transport_node_collections_facts
nsxt_transport_node_profiles
nsxt_transport_node_profiles_facts
nsxt_compute_collection_transport_templates
nsxt_compute_collection_transport_templates_facts
nsxt_controller_manager_auto_deployment

Logical networking modules

nsxt_logical_ports
nsxt_logical_ports_facts
nsxt_logical_routers
nsxt_logical_routers_facts
nsxt_logical_router_ports
nsxt_logical_router_ports_facts
nsxt_logical_router_static_routes
nsxt_logical_switches
nsxt_logical_switches_facts
nsxt_ip_blocks
nsxt_ip_blocks_facts

Prerequisites

We assume that ansible is already installed. These modules support ansible version 2.7 and onwards.

PyVmOmi - Python library for vCenter api.
OVF Tools - Ovftool is used for ovf deployment.

Build & Run

Install PyVmOmi

pip install --upgrade pyvmomi pyvim requests ssl

Download and Install Ovf tool 4.3 - Ovftool (Note: Using ovftool version 4.0/4.1 causes OVA/OVF deployment failure with Error: cURL error: SSL connect error\nCompleted with errors\n)

Download ansible-for-nsxt.

unzip ansible-for-nsxt-master.zip
cd ansible-for-nsxt-master

To run a sample Ansible playbook - To create a sample test topology using deployments and install module.

Edit test_basic_topology.yml and answerfile.yml to match values to your environment.

ansible-playbook test_basic_topology.yml -vvv

Interoperability

The following versions of NSX are supported:

NSX-T 2.4
Ansible 2.7

Contributing

The ansible-for-nsxt project team welcomes contributions from the community. Before you start working with ansible-for-nsxt, please read our Developer Certificate of Origin. All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch. For more detailed information, refer to CONTRIBUTING.md.

Support

The NSX-T Ansible modules in this repository are community supported. For bugs and feature requests please open a Github Issue and label it appropriately. As this is a community supported solution there is no SLA for resolutions.

License

The NSX-T Ansible modules in this repository are available under BSD-2 license or GPLv3 applies to all parts of the ansible-for-nsxt. You may not use them except in compliance with the License.

dahr / nsxt-for-pks