ansible-for-nsxt-docs
latest
  • nsxt_certificates_facts – List all existing certificates
  • nsxt_certificates – Add a New Certificate
  • nsxt_cluster_profiles_facts – List Cluster Profiles
  • nsxt_cluster_profiles – Create a Cluster Profile
  • nsxt_deploy_ova – Deploys NSXT Manager
  • nsxt_edge_clusters_facts – List Edge Clusters
  • nsxt_edge_clusters – Create Edge Cluster
  • nsxt_fabric_compute_managers_facts – Return the List of Compute managers
  • nsxt_fabric_compute_managers – Register compute manager with NSX
  • nsxt_ip_blocks_facts – Returns list of configured IP address blocks
  • nsxt_ip_blocks – Create a new IP address block
  • nsxt_ip_pools_facts – List IP Pools
  • nsxt_ip_pools – Create an IP Pool
  • nsxt_licenses_facts – Get all licenses
  • nsxt_licenses – Add a new license key
  • nsxt_logical_ports_facts – List All Logical Ports
  • nsxt_logical_ports – Create a Logical Port
  • nsxt_logical_router_ports_facts – List Logical Router Ports
  • nsxt_logical_router_ports – Create a Logical Router Port description: Creates a logical router port. The required parameters include resource_type (LogicalRouterUpLinkPort, LogicalRouterDownLinkPort, LogicalRouterLinkPort, LogicalRouterLoopbackPort, LogicalRouterCentralizedServicePort); and logical_router_id (the router to which each logical router port is assigned). The service_bindings parameter is optional
  • nsxt_logical_router_static_routes – Add Static Routes on a Logical Router
  • nsxt_logical_routers_facts – List Logical Routers
  • nsxt_logical_routers – Create a Logical Router
  • nsxt_logical_switches_facts – List All Logical Switches
  • nsxt_logical_switches – Create a Logical Switch
  • nsxt_manager_auto_deployment_facts – Returns info for all cluster node VM auto-deployment attempts
  • nsxt_manager_auto_deployment – Deploy and register a cluster node VM
  • nsxt_manager_status – Shows status of nsxt manager
  • nsxt_policy_bfd_profile – Create or Delete a Policy BFD Profile
  • nsxt_policy_gateway_policy – Update a Gateway Policy
  • nsxt_policy_group – Create or Delete a Policy Policy Group
  • nsxt_policy_ip_block – Create or Delete a Policy IP Block
  • nsxt_policy_ip_pool – Create or Delete a Policy IP Pool
  • nsxt_policy_l2_bridge_ep_profile – Create or Delete a Policy L2 Bridge Endpoint Profile
  • nsxt_policy_security_policy – Create or Delete a Policy Security Policy
  • nsxt_policy_segment – Create or Delete a Policy Segment
  • nsxt_policy_tier0 – Create/Update/Delete a Tier-0 and associated resources
  • nsxt_policy_tier1 – Create/Update/Delete a Tier-1 and associated resources
  • nsxt_principal_identities_facts – List all existing principal identities
  • nsxt_principal_identities – Register a name-certificate combination
  • nsxt_repo_sync_facts – Get synchronize status of a manager node
  • nsxt_repo_sync – Synchronizes the repository data between nsx managers
  • nsxt_route_advertise – Toggle tier 1 route advertisement
  • nsxt_transport_node_collections_facts – List Transport Node collections
  • nsxt_transport_node_collections – Create transport node collection by attaching Transport Node Profile to cluster. description: When transport node collection is created the hosts which are part of compute collection will be prepared automatically i.e. NSX Manager attempts to install the NSX components on hosts. Transport nodes for these hosts are created using the configuration specified in transport node profile
  • nsxt_transport_node_profiles_facts – List Transport Nodes Profiles
  • nsxt_transport_node_profiles – Create a Transport Node Profile description: Transport node profile captures the configuration needed to create a transport node. A transport node profile can be attached to compute collections for automatic TN creation of member hosts
  • nsxt_transport_nodes_facts – List Transport Nodes
  • nsxt_transport_nodes – Create a Transport Node
  • nsxt_transport_zones_facts – List Transport Zones
  • nsxt_transport_zones – Create a Transport Zone
  • nsxt_upgrade_eula_accept_facts – Gets EULA acceptance status and contents
  • nsxt_upgrade_eula_accept – Accept end user license agreement
  • nsxt_upgrade_group_facts – Get the upgrade groups information
  • nsxt_upgrade_groups – Create a group of upgrade units
  • nsxt_upgrade_history – Get upgrade history
  • nsxt_upgrade_plan_facts – Get the upgrade plan settings for the component
  • nsxt_upgrade_plan – Upgrade plan settings for the component
  • nsxt_upgrade_postchecks – Execute post-upgrade checks
  • nsxt_upgrade_pre_post_checks_facts – Get the pre and post upgrade checks
  • nsxt_upgrade_prechecks – Execute pre-upgrade checks
  • nsxt_upgrade_run – Start the upgrade
  • nsxt_upgrade_status_summary_facts – Get the upgrade groups information
  • nsxt_upgrade_uc_facts – Get upgrade-coordinator upgrade status
  • nsxt_upgrade_uc – Upgrade the upgrade coordinator
  • nsxt_upload_upgrade_bundle_facts – Get uploaded upgrade bundle information
  • nsxt_upgrade_upload_mub – Uploads upgrade mub
  • nsxt_uplink_profiles_facts – List Hostswitch Profiles
  • nsxt_uplink_profiles – Create a Hostswitch Profile
    • Synopsis
    • Parameters
    • Examples
    • Status
      • Authors
  • nsxt_vitual_ip_facts – Read cluster virtual IP address
  • nsxt_virtual_ip – Sets and clears cluster virtual IP address
  • nsxt_vm_tags – Update tags on NSXT VM
ansible-for-nsxt-docs
  • »
  • nsxt_uplink_profiles – Create a Hostswitch Profile
  • Edit on GitHub

nsxt_uplink_profiles – Create a Hostswitch Profile¶

New in version 2.7.

  • Synopsis

  • Parameters

  • Examples

  • Status

Synopsis¶

  • Creates a hostswitch profile. The resource_type is required. For uplink profiles, the teaming and policy parameters are required. By default, the mtu is 1600 and the transport_vlan is 0. The supported MTU range is 1280 through 9000.

Parameters¶

Parameter Choices/Defaults Comments
description
string
Description of the resource
display_name
string / required
Display name
enabled
boolean
The enabled property specifies the status of NIOC feature. When enabled is set to true, NIOC feature is turned on and the bandwidth allocations specified for the traffic resources are enforced. When enabled is set to false, NIOC feature is turned off and no bandwidth allocation is guaranteed. By default, enabled will be set to true.
extra_configs
array of ExtraConfig
list of extra configs
host_infra_traffic_res
array of ResourceAllocation
host_infra_traffic_res specifies bandwidth allocation for various traffic resources.
hostname
string / required
Deployed NSX manager hostname.
lags
array of Lag
list of LACP group
mtu
integer
Maximum Transmission Unit used for uplinks
named_teamings
array of NamedTeamingPolicy
List of named uplink teaming policies that can be used by logical switches
overlay_encap
string
The protocol used to encapsulate overlay traffic
password
string / required
The password to authenticate with the NSX manager.
required_capabilities
list
None
resource_type
string / required
    Choices:
  • UplinkHostSwitchProfile
Supported HostSwitch profiles.
send_enabled
boolean
Enabled or disabled sending LLDP packets
state
- / required
    Choices:
  • present
  • absent
State can be either 'present' or 'absent'. 'present' is used to create or update resource. 'absent' is used to delete resource.
tags
Array of Tag
Opaque identifier meaninful to API user
teaming
dictionary / required
Default TeamingPolicy associated with this UplinkProfile
transport_vlan
integer
VLAN used for tagging Overlay traffic of associated HostSwitch
username
string / required
The username to authenticate with the NSX manager.

Examples¶

- name: Create a Hostswitch Profile
  nsxt_uplink_profiles:
      hostname: "10.192.167.137"
      username: "admin"
      password: "Admin!23Admin"
      validate_certs: False
      display_name: "uplinkProfile1",
      mtu: 1600,
      resource_type: "UplinkHostSwitchProfile",
      teaming:
        active_list:
        - uplink_name: "uplink-1"
          uplink_type: PNIC
        policy: FAILOVER_ORDER
      transport_vlan: 0,
      state: "present",

Status¶

  • This module is not guaranteed to have a backwards compatible interface. [preview]

  • This module is maintained by the Ansible Community. [community]

Authors¶

  • Rahul Raghuvanshi

Next Previous

© Copyright Revision abb080a6.

Built with Sphinx using a theme provided by Read the Docs.