Freeipa/host
@shrug/freeipa/hostv2026.07.11.1
01README
Manage FreeIPA hosts over the JSON-RPC API: find/show read-only snapshots plus add/mod/del/disable writes and a desired-state sync reconcile, each with an audit trail and a confirm-guarded delete. add random:true vaults the one-time enrollment password; add/del take an optional idempotent flag.
02Models
@shrug/freeipa/hostv2026.07.11.1host.ts
fn find()
Snapshot hosts matching an optional search criteria (read-only).
fn show(fqdn: string)
Snapshot a single host by fqdn (read-only).
| Argument | Type | Description |
|---|---|---|
| fqdn | string | Host fully-qualified domain name to fetch |
fn add(fqdn: string)
Create a host (host_add). With random:true IPA returns a one-time enrollment password, vaulted onto the host state and kept out of the audit. Writes the created host state on success; audits both paths.
| Argument | Type | Description |
|---|---|---|
| fqdn | string | Host fully-qualified domain name |
fn mod(fqdn: string)
Modify a host (host_mod). Writes the updated host state on success; audits both paths.
| Argument | Type | Description |
|---|---|---|
| fqdn | string | Host fully-qualified domain name to modify |
fn del(fqdn: string)
Delete a host (host_del). Requires confirm:true; audits both paths.
| Argument | Type | Description |
|---|---|---|
| fqdn | string | Host fully-qualified domain name to delete |
fn disable(fqdn: string)
Disable a host (host_disable): revoke its keytab and held certificates. This is NOT a deletion — the host entry remains. Writes the updated host state on success; audits both paths.
| Argument | Type | Description |
|---|---|---|
| fqdn | string | Host fully-qualified domain name |
fn sync(fqdn: string)
Reconcile a host to a desired spec: create it if absent (host_add), otherwise host_mod only the drifted attributes (description/os + extra options). Idempotent — a converged host issues no IPA writes. Writes the converged host state on success; audits both paths, and the audit response lists the `changes` made.
| Argument | Type | Description |
|---|---|---|
| fqdn | string | Host fully-qualified domain name |
Resources
hosts(infinite)— Snapshot of hosts matching a find (array of parsed rows)
host(infinite)— Snapshot of a single host (parsed row + raw entry); carries the sensitive one-time enrollment password when add generated one
attempt(infinite)— Audit record of a mutation attempt (request + result/error + timestamp). Written on both success and failure.
03Stats
A
100 / 100
Downloads
0
Archive size
23.1 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
Repository
https://github.com/shrugpw/swamp-freeipa04Platforms
05Labels