Resource Type: foreman_user

Defined in:
lib/puppet/type/foreman_user.rb
Providers:
user

Overview

Adds a new (local) user to authenticate with the Foreman web UI.

Properties

  • auth_source

    The name of the authentication source. Either ‘Internal’ or the name of the LDAP server that has already been defined in Foreman.

  • email

    The optional email address of the user.

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • firstname

    The first name of the user.

  • lastname

    The first name of the user.

  • password

    The password to authenticate the user with.

  • web_admin (defaults to: false)

    Whether or not to make the user an admin in the web UI.

    Supported values:
    • true
    • false

Parameters

  • admin_password

    The password for the Foreman admin user.

  • admin_user

    The admin user for the Foreman REST API.

  • api_admin (defaults to: false)

    Whether or not to make the user an interal API admin.

    Supported values:
    • true
    • false
  • host

    The host that the foreman server is running on.

  • name (namevar)

    The name of the user to be added.

  • provider

    The specific backend to use for this ‘foreman_user` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

  • ssl_ca_file (defaults to: /etc/foreman/pki/cacerts/cacerts.pem)

    The CA file by which the the :host should be validated

  • ssl_client_cert (defaults to: /etc/foreman/pki/public/)

    The client PKI certificate that will be recognized by the :host

  • ssl_client_key (defaults to: /etc/foreman/pki/private/)

    The client PKI private key that will be recognized by the :host

  • ssl_version (defaults to: TLSv1_2)

    The SSL version that should be negotiated with the remote host

    You can get a list of valid versions by running the following on the client system:

    ruby -ropenssl -e 'puts OpenSSL::SSL::SSLContext::METHODS'