freeipa.ansible_freeipa.ipanetgroup (1.11.1) — module

NIS entities can be stored in netgroups.

Authors: Denis Karpelevich (@dkarpele)

preview | supported by community

Install collection

Install with ansible-galaxy collection install freeipa.ansible_freeipa:==1.11.1


Add to requirements.yml

  collections:
    - name: freeipa.ansible_freeipa
      version: 1.11.1

Description

A netgroup is a group used for permission checking. It can contain both user and host values.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure netgroup my_netgroup1 is present
  freeipa.ansible_freeipa.ipanetgroup:
    ipaadmin_password: SomeADMINpassword
    name: my_netgroup1
    description: My netgroup 1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure netgroup my_netgroup1 is absent
  freeipa.ansible_freeipa.ipanetgroup:
    ipaadmin_password: SomeADMINpassword
    name: my_netgroup1
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure netgroup is present with user "user1"
  freeipa.ansible_freeipa.ipanetgroup:
    ipaadmin_password: SomeADMINpassword
    name: TestNetgroup1
    user: user1
    action: member
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure netgroup user, "user1", is absent
  freeipa.ansible_freeipa.ipanetgroup:
    ipaadmin_password: SomeADMINpassword
    name: TestNetgroup1
    user: "user1"
    action: member
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure netgroup is present with members
  freeipa.ansible_freeipa.ipanetgroup:
    ipaadmin_password: SomeADMINpassword
    name: TestNetgroup1
    user: user1,user2
    group: group1
    host: host1
    hostgroup: ipaservers
    netgroup: admins
    action: member
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Ensure 2 netgroups TestNetgroup1, admins are absent
  freeipa.ansible_freeipa.ipanetgroup:
    ipaadmin_password: SomeADMINpassword
    name:
    - TestNetgroup1
    - admins
    state: absent

Inputs

    
host:
    aliases:
    - hosts
    description: List of host names assigned to this netgroup.
    elements: str
    required: false
    type: list

name:
    aliases:
    - cn
    description: The list of netgroup name strings.
    elements: str
    required: true
    type: list

user:
    aliases:
    - users
    description: List of user names assigned to this netgroup.
    elements: str
    required: false
    type: list

group:
    aliases:
    - groups
    description: List of group names assigned to this netgroup.
    elements: str
    required: false
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description: The state to ensure.
    type: str

action:
    choices:
    - member
    - netgroup
    default: netgroup
    description: Work on netgroup or member level
    required: false
    type: str

netgroup:
    aliases:
    - netgroups
    description: List of netgroup names assigned to this netgroup.
    elements: str
    required: false
    type: list

hostgroup:
    aliases:
    - hostgroups
    description: List of host group names assigned to this netgroup.
    elements: str
    required: false
    type: list

nisdomain:
    aliases:
    - nisdomainname
    description: NIS domain name
    required: false
    type: str

nomembers:
    description: Suppress processing of membership attributes
    required: false
    type: bool

description:
    aliases:
    - desc
    description: Netgroup description
    required: false
    type: str

ipaapi_context:
    choices:
    - server
    - client
    description: 'The context in which the module will execute. Executing in a

      server context is preferred. If not provided context will be

      determined by the execution environment.

      '
    required: false
    type: str

delete_continue:
    aliases:
    - continue
    default: true
    description: 'Continuous mode. Don''t stop on errors. Valid only if `state` is `absent`.

      '
    type: bool

ipaadmin_password:
    description: The admin password.
    required: false
    type: str

ipaapi_ldap_cache:
    default: true
    description: Use LDAP cache for IPA connection.
    type: bool

ipaadmin_principal:
    default: admin
    description: The admin principal.
    type: str