morpheus.core.appliance_settings (0.5.1) — module

Install collection

Install with ansible-galaxy collection install morpheus.core:==0.5.1

Add to requirements.yml

  collections:
    - name: morpheus.core
      version: 0.5.1

Description

Configures Morpheus Appliance Settings

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure SMTP Settings
  morpheus.core.appliance_settings:
    smtp_server: smtp.domain.tld
    smtp_port: 25
    smtp_tls: true

Scanned by Steampunk Spotter

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

- name: Set Appliance URL
  morpheus.core.appliance_settings:
    appliance_url: cmp.domain.tld

Inputs

    
smtp_ssl:
    description:
    - Use SSL to connect to the defined SMTP Server
    type: bool

smtp_tls:
    description:
    - Use TLS to connect to the defined SMTP Server
    type: bool

smtp_port:
    description:
    - Set the SMTP Server Port to connect to
    type: int

smtp_user:
    description:
    - User to Authenticate with the defined SMTP Server
    type: string

proxy_host:
    description:
    - Define a Proxy Server
    type: string

proxy_port:
    description:
    - Set the Proxy Server port
    type: int

proxy_user:
    description:
    - User to Authenticate with the defined Proxy Server
    type: string

smtp_server:
    description:
    - Set the SMTP Server to relay email through
    type: string

cors_allowed:
    description:
    - Define origins allowed to access the Morpheus API.
    type: string

currency_key:
    description:
    - Set the API Key for the defined Currency Provider
    type: string

proxy_domain:
    description:
    - Set the Proxy Domain
    type: string

appliance_url:
    description:
    - Defines the URL of the Morpheus Appliance.
    type: string

smtp_password:
    description:
    - Password to Authenticate with the define SMTP Server
    type: string

proxy_password:
    description:
    - Password to Authenticate with the define Proxy Server
    type: string

smtp_mail_from:
    description:
    - Set the SMTP Mail From address header
    type: string

default_role_id:
    description:
    - Set the default Tenant Role applied to new Tenant Registrations.
    type: int

expire_pwd_days:
    description:
    - Expire passwords after this number of days. 0 disables this feature.
    type: int

currency_provider:
    description:
    - Define a Currency Provider
    type: string

enable_zone_types:
    description:
    - Specify List of Cloud (Zone) Types to Enable
    elements: int
    type: list

proxy_workstation:
    description:
    - Set the Proxy Workstation
    type: string

disable_zone_types:
    description:
    - Specify List of Cloud (Zone) Types to Disable
    elements: int
    type: list

password_min_length:
    description:
    - Define the minimum length for passwords.
    type: int

default_user_role_id:
    description:
    - Set the default User Role applied the user created from Tenant Registration.
    type: int

password_min_numbers:
    description:
    - Define the minimum number of numbers in passwords.
    type: int

password_min_symbols:
    description:
    - Define the minimum number of symbols in passwords.
    type: int

registration_enabled:
    description:
    - Enable new users to register a new tenant.
    type: bool

docker_privilged_mode:
    description:
    - Enable or Disable Docker privileged mode.
    type: bool

enable_all_zone_types:
    description:
    - Enable All Cloud (Zone) Types
    type: bool

warn_user_days_before:
    description:
    - Warn user this number of days before account is disabled.
    type: int

disable_after_attempts:
    description:
    - Disable user account after this number of failed login attempts.
    type: int

disable_all_zone_types:
    description:
    - Disable All Cloud (Zone) Types
    type: bool

internal_appliance_url:
    description:
    - Defines the Internal URL of the Morpheus Appliance.
    type: string

password_min_upper_case:
    description:
    - Define the minimum number of upper case characters in passwords.
    type: int

disable_after_days_inactive:
    description:
    - Disable user account after this number of days of inactivity.
    type: int

user_browser_session_timeout:
    description:
    - Define the period of time in minutes to logout an idle user session.
    type: int

user_browser_session_warning:
    description:
    - Define the period of time in minutes to warn the user of session timeout.
    type: int

Outputs

appliance_settings:
  description:
  - The current Morpheus Appliance Settings
  returned: success
  sample:
    appliance_settings:
      appliance_url: https://cmp.domain.tld
      cors_allowed: null
      currency_key: null
      currency_provider: null
      default_role_id: null
      default_user_role_id: null
      disable_after_attempts: '5'
      disable_after_days_inactive: null
      docker_privileged_mode: false
      enabled_zone_types:
      - id: 4
        name: Amazon
      - id: 9
        name: Azure (Public)
      - id: 11
        name: DigitalOcean
      - id: 3
        name: Morpheus
      - id: 18
        name: Oracle Public Cloud
      - id: 40
        name: PowerVC
      - id: 17
        name: UpCloud
      - id: 38
        name: VMware Fusion
      - id: 28
        name: VMware vCenter
      - id: 34
        name: vCloud Director
      expire_pwd_days: null
      internal_appliance_url: null
      maintenance_mode: false
      proxy_domain: null
      proxy_host: null
      proxy_password: null
      proxy_password_hash: null
      proxy_port: null
      proxy_user: null
      proxy_workstation: null
      registration_enabled: false
      smtp_mail_from: morpheus@domain.tld
      smtp_password: null
      smtp_password_hash: null
      smtp_port: '25'
      smtp_server: smtp.domain.tld
      smtp_ssl: false
      smtp_tls: true
      smtp_user: null
      stats_retainment_period: null
      warn_user_days_before: null
  type: dict
success:
  description:
  - If the API Request was Successful
  returned: always
  sample:
    success: true
  type: bool