/ home / dellemc / dellemc.vxrail / 2.2.0 / module / dellemc_vxrail_cluster_layer3_remove_segment

dellemc.vxrail.dellemc_vxrail_cluster_layer3_remove_segment (2.2.0) — module

Remove segment on VxRail cluster layer3.

| "added in version" 1.4.0 of dellemc.vxrail"

Authors: VxRail Development Team(@VxRailDevTeam) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.vxrail:==2.2.0

Add to requirements.yml

  collections:
    - name: dellemc.vxrail
      version: 2.2.0

Description

This module will delete a segment.

Usage examples

Scanned by Steampunk Spotter

  - name: Remove Cluster Layer3 Segment
    dellemc_vxrail_cluster_layer3_remove_segment:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        segment_label: "{{ segment_label }}"
        api_version_number: "{{ api_version_number }}"

Inputs

    
vxmip:
    description: The IP address of the VxRail Manager System
    required: true
    type: str

timeout:
    default: 60
    description: Time out value for getting system infomation, the default value is 60
      seconds
    required: false
    type: int

vcadmin:
    description: Administrative account of the vCenter Server the VxRail Manager is registered
      to
    required: true
    type: str

vcpasswd:
    description: The password for the administrator account provided in vcadmin
    required: true
    type: str

segment_label:
    description: The label of the current segment to be acted upon
    required: true
    type: str

api_version_number:
    description: The version of API to call
    type: int

Outputs

Cluster_Layer3_Remove_Segment_Information:
  description: Delete a segment
  returned: always
  sample: "{\n    \"code\": \"10000001\"\n    \"message\": \"Delete segment rack-temp-1\
    \ successfully.\"\n}"
  type: dict