/ home / arubanetworks / arubanetworks.aruba_central / 1.0.3 / module / central_sites

arubanetworks.aruba_central.central_sites (1.0.3) — module

REST API module for sites on Aruba Central

| "added in version" 2.9.0 of arubanetworks.aruba_central"

Authors: unknown

preview | supported by community

Install collection

Install with ansible-galaxy collection install arubanetworks.aruba_central:==1.0.3

Add to requirements.yml

  collections:
    - name: arubanetworks.aruba_central
      version: 1.0.3

Description

This module provides a mechanism to interact with sites used for monitoring devices on Aruba Central

Usage examples

Scanned by Steampunk Spotter

#Usage Examples
- name: Get site details for a single site
  central_sites:
    action: get
    site_id: 40

Scanned by Steampunk Spotter

- name: Get site details for multiple sites
  central_sites:
    action: get_multiple_sites
    calculate_total: True
    sort: +site_name
    offset: 0
    limit: 20

Scanned by Steampunk Spotter

- name: Create a new site using site address
  central_sites:
    action: create
    site_name: test-site
    site_address:
      address: 3333 Scott Blvd
      city: Santa Clara
      state: California
      country: United States
      zipcode: 95054

Scanned by Steampunk Spotter

- name: Create a new site using geolocation cordinates
  central_sites:
    action: create
    site_name: test-site
    geolocation:
      latitude: 15.3241334
      longitude: -124.5132145

Scanned by Steampunk Spotter

- name: Update an existing site's name and/or address
  central_sites:
    action: update
    site_id: 42
    site_name: test-site
    site_address:
      address: 3333 Scott Boulevard Building D
      city: Santa Clara
      state: California
      country: United States
      zipcode: 95054

Scanned by Steampunk Spotter

- name: Update an existing site's name and/or geolocation coordinates
  central_sites:
    action: update
    site_id: 43
    site_name: test-site
    geolocation:
      latitude: 18.3241334
      longitude: -122.5132145

Scanned by Steampunk Spotter

- name: Associate devices to a site
  central_sites:
    action: associate
    site_id: 43
    device_type: IAP
    device_list:
      - CNXXXXXXXX
      - CNXXXXXXYY
      - CNXXXXXXZZ

Scanned by Steampunk Spotter

- name: Unassociate devices from a site
  central_sites:
    action: unassociate
    site_id: 43
    device_type: IAP
    device_list:
     - CNXXXXXXXX
     - CNXXXXXXYY

Scanned by Steampunk Spotter

- name: Delete an existing site
  central_sites:
    action: delete
    site_id: 42

Inputs

    
sort:
    choices:
    - +site_name
    - -site_name
    default: +site_name
    description:
    - Sorts output by alphabetical (+site_name) or reverse alphabetical (-site_name) order
      of site name
    - Used optionally with action I(get_multiple_sites)
    required: false
    type: str

limit:
    default: 100
    description:
    - Number of records to be returned
    - A maximum of 1000 records can be returned
    - Used optionally as a filter parameter for I(get_multiple_sites)
    required: false
    type: int

action:
    choices:
    - get
    - get_multiple_sites
    - create
    - update
    - associate
    - unassociate
    - delete
    description:
    - Action to be performed on the site(s)
    - I(get) gets details of a particular site
    - I(get_multiple_sites) gets number of sites and details of each site
    - I(create) creates a new site - either geolocation OR "site_address" should be specified,
      but not both
    - I(update) updates the site name and/or location. For location, either geolocation
      OR "site_address" should be specified, but not both
    - I(associate) associates devices to a site
    - I(unassociate) unassociates devices from a site
    - I(delete) deletes a site
    required: true
    type: str

offset:
    default: 0
    description:
    - Number of items to be skipped before returning the data, which is useful for pagination
    - Used optionally as a filter parameter for I(get_multiple_sites)
    required: false
    type: int

site_id:
    description:
    - Numerical ID of the site
    - Used with actions I(get), I(update), I(associate), I(unassociate), and I(delete)
    required: false
    type: int

site_name:
    description:
    - Name of the site
    - Used with actions I(create) and I(update)
    required: false
    type: str

device_list:
    description:
    - List of device serial numbers
    - A maximum of 5000 device serial numbers are allowed
    - Used with actions I(associate) and I(unassociate)
    required: false
    type: list

device_type:
    choices:
    - IAP
    - SWITCH
    - CONTROLLER
    description:
    - Type of device(s)
    - Used with actions I(associate) and I(unassociate)
    required: false
    type: str

geolocation:
    description:
    - Latitude and longitude coordinates of the site
    - Mutually exclusive with "site_address"
    required: false
    suboptions:
      latitude:
        description:
        - Latitude coordinate
        required: true
        type: str
      longitude:
        description:
        - Longitude coordinate
        required: true
        type: str
    type: dict

site_address:
    description:
    - Full street address of the site
    - Mutually exclusive with "geolocation"
    required: false
    suboptions:
      address:
        description:
        - Address line(s)
        required: true
        type: str
      city:
        description:
        - City
        required: true
        type: str
      country:
        description:
        - Country
        required: true
        type: str
      state:
        description:
        - State
        required: true
        type: str
      zipcode:
        description:
        - ZIP code
        required: false
        type: str
    type: dict

calculate_total:
    default: true
    description:
    - Counts total number of labels
    - Used optionally with action I(get_multiple_sites)
    required: false
    type: bool