phoenixnap.bmc.reservation_info (1.17.0) — module

Install collection

Install with ansible-galaxy collection install phoenixnap.bmc:==1.17.0

Add to requirements.yml

  collections:
    - name: phoenixnap.bmc
      version: 1.17.0

Description

Retrieves all reservations associated with the authenticated account. All date & times are in UTC.

This module has a dependency on requests

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# All the examples assume that you have file config.yaml with your 'clientId' and 'clientSecret'
# in location: ~/.pnap/config.yaml

- name: List all server reservations
  hosts: localhost
  gather_facts: false
  vars_files:
    - ~/.pnap/config.yaml
  tasks:
    - name: List all server reservation
      phoenixnap.bmc.reservation_info:
        client_id: "{{ clientId }}"
        client_secret: "{{ clientSecret }}"
        product_category: server
      register: output
    - name: Print the gathered infos
      ansible.builtin.debug:
        var: output.reservations

Inputs

    
client_id:
    description: Client ID (Application Management)
    type: str

client_secret:
    description: Client Secret (Application Management)
    type: str

product_category:
    description: The product category (server, bandwidth, operating-system, public_ip).
    type: str

Outputs

reservations:
  contains:
    assignedResourceId:
      description: The resource ID currently being assigned to Reservation..
      returned: always
      sample: 83604275-bdba-490a-b87a-978e8dffdb14
      type: str
    autoRenew:
      description: A flag indicating whether the reservation will auto-renew (default
        is true).
      returned: always
      sample: true
      type: bool
    endDateTime:
      description: The point in time (in UTC) when the reservation end.
      returned: always
      type: str
    id:
      description: The reservation identifier.
      returned: always
      sample: 83604275-bdba-490a-b87a-978e8dffdb14
      type: str
    initialInvoiceModel:
      description:
      - Reservations created with initial invoice model ON_CREATION will be invoiced
        on same date when reservation is created.
      - Reservation created with CALENDAR_MONTH initial invoice model will be invoiced
        at the beginning of next month.
      returned: always
      sample: ONE_MONTH_RESERVATION
      type: str
    lastRenewalDateTime:
      description: The point in time (in UTC) when the reservation was renewed last.
      returned: always
      type: str
    location:
      description: The location code.
      returned: always
      sample: PHX
      type: str
    nextBillingDate:
      description: Next billing date for Reservation.
      returned: always
      sample: '2020-04-19'
      type: str
    nextRenewalDateTime:
      description: The point in time (in UTC) when the reservation will be renewed
        if auto renew is set to true.
      returned: always
      type: str
    price:
      description: Reservation price..
      returned: always
      sample: 175
      type: int
    priceUnit:
      description: The unit to which the price applies..
      returned: always
      sample: MONTH
      type: str
    productCategory:
      description: The product category
      returned: always
      sample: server
      type: str
    productCode:
      description: The code identifying the product. This code has significant across
        all locations.
      returned: always
      sample: d1.tiny
      type: str
    reservationModel:
      description: The Reservation Model.
      returned: always
      sample: ONE_MONTH_RESERVATION
      type: str
    sku:
      description:
      - The sku that will be applied to this reservation.
      - It is useful to find out the price by querying the /product endpoint.
      returned: always
      sample: XXX-XXX-XXX
      type: str
    startDateTime:
      description: The point in time (in UTC) when the reservation starts.
      returned: always
      type: str
  description: The reservations information as list
  returned: success
  type: complex