xoxys.ucs/README.md

# xoxys.ucs

[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.ucs/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.ucs)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.ucs/src/branch/main/LICENSE)

Configure an [Univention Corporate Server](https://www.univention.com/products/ucs/).
UCS is a server appliance with an integrated management system for the central and
cross-platform administration of servers, services, clients, desktops and users as well as
virtualized computers operated in UCS.

{{< hint type=important >}}
This role covers only some really basic configurations and should be considered as not production ready.
{{< /hint >}}

## Table of content

- [Requirements](#requirements)
- [Default Variables](#default-variables)
  - [ucs_cronjobs](#ucs_cronjobs)
  - [ucs_filesystem_acl](#ucs_filesystem_acl)
  - [ucs_registry_extra](#ucs_registry_extra)
  - [ucs_repository_unmaintained_enabled](#ucs_repository_unmaintained_enabled)
  - [ucs_system_groups](#ucs_system_groups)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)

---

## Requirements

- Minimum Ansible version: `2.10`

## Default Variables

### ucs_cronjobs

#### Default value

```YAML
ucs_cronjobs: []
```

#### Example usage

```YAML
ucs_cronjobs:
  - name: backup-cleanup
    job: "find /var/univention-backup -mtime +7 -delete"
    user: root
    minute: 0
    hour: 3
    day: "*"
    weekday: "*"
    month: "*"
    state: present
```

### ucs_filesystem_acl

#### Default value

```YAML
ucs_filesystem_acl: []
```

#### Example usage

```YAML
ucs_filesystem_acl:
  - path: /shares/mydocuments # needs to be set
    entity: john # needs to be set
    etype: user # needs to be set
    permissions: rw # needs to be set
    state: # defaults to 'query'
    recursive: # defaults to 'no'
```

### ucs_registry_extra

#### Default value

```YAML
ucs_registry_extra: []
```

#### Example usage

```YAML
ucs_registry_extra:
  - path: timeserver
    value: "ntp.example.com"
    state: present
```

### ucs_repository_unmaintained_enabled

#### Default value

```YAML
ucs_repository_unmaintained_enabled: false
```

### ucs_system_groups

#### Default value

```YAML
ucs_system_groups: []
```

#### Example usage

```YAML
ucs_system_groups:
  - name: fs-mydocuments-rw # needs to be set
    description: # defaults to not set
    subpath: # defaults to not set
    ou: # defaults to not set
    state: # defaults to 'present'
```

## Dependencies

None.

## License

MIT

## Author

[Robert Kaussow](https://gitea.rknet.org/xoxys)