dscreate

title: dscreate(8)

text:
# dscreate(8)

## NAME
dscreate

## SYNOPSIS
dscreate [-h] [-v] [-j] {from-file,interactive,create-template,ds-root} ...

## OPTIONS

### Sub-commands
dscreate from-file

Create an instance of Directory Server from an inf answer file

dscreate interactive

Start interactive installer for Directory Server installation

dscreate create-template

Display an example inf answer file, or provide a file name to write it to disk.

dscreate ds-root

Prepare a root directory in which non root user can create, run and administer instances.

## OPTIONS 'dscreate from-file'
usage: dscreate from-file [-h] [-n] file

file

Inf file to use with prepared answers. You can generate an example of this with 'dscreate create-template'

-n, --dryrun

Validate system and configurations only. Do not alter the system.

## OPTIONS 'dscreate interactive'
usage: dscreate interactive [-h]

## OPTIONS 'dscreate create-template'
usage: dscreate create-template [-h] [--advanced] [template_file]

template_file

Write example template to this file

--advanced

Add advanced options to the template - changing the advanced options may make your instance install fail

## OPTIONS 'dscreate ds-root'
usage: dscreate ds-root [-h] root_dir [bin_dir]

root_dir

A directory that will be used as virtual root.

bin_dir

A directory in which administration wrappers are installed. (Should be in PATH)

-v, --verbose

Display verbose operation tracing during command execution

-j, --json

Return the result as a json message

## COMMENTS
Example of install by a non root user:

PATH=$HOME/bin:$PATH # Should be in .profile

dscreate ds-root $HOME/mydsroot $HOME/bin

hash -d dscreate # bash command to insure new dscreate wrapper will be used

dscreate interactive

\# Note: Make sure to use non priviledged port number (i.e > 1000)

## AUTHORS
lib389 was written by Red Hat, Inc., and William Brown <389-devel@lists.fedoraproject.org>.

## DISTRIBUTION
The latest version of lib389 may be downloaded from http://www.port389.org/docs/389ds/FAQ/upstream-test-framework.html


dsctl

title: dsctl(8)

text:
# dsctl(8)

## NAME
dsctl

## SYNOPSIS
dsctl [-h] [-v] [-j] [-l] [instance] {restart,start,stop,status,remove,db2index,db2bak,db2ldif,dbverify,bak2db,ldif2db,backups,ldifs,tls,healthcheck,get-nsstate,ldifgen,dsrc,cockpit,dblib} ...

## OPTIONS
instance

The name of the instance to act upon

### Sub-commands
dsctl restart

Restart an instance of Directory Server, if it is running: else start it.

dsctl start

Start an instance of Directory Server, if it is not currently running

dsctl stop

Stop an instance of Directory Server, if it is currently running

dsctl status

Check running status of an instance of Directory Server

dsctl remove

Destroy an instance of Directory Server, and remove all data.

dsctl db2index

Initialise a reindex of the server database. The server must be stopped for this to proceed.

dsctl db2bak

Initialise a BDB backup of the database. The server must be stopped for this to proceed.

dsctl db2ldif

Initialise an LDIF dump of the database. The server must be stopped for this to proceed.

dsctl dbverify

Perform a db verification. You should only do this at direction of support

dsctl bak2db

Restore a BDB backup of the database. The server must be stopped for this to proceed.

dsctl ldif2db

Restore an LDIF dump of the database. The server must be stopped for this to proceed.

dsctl backups

List backup's found in the server's default backup directory

dsctl ldifs

List all the LDIF files located in the server's LDIF directory

dsctl tls

Manage TLS certificates

dsctl healthcheck

Run a healthcheck report on a local Directory Server instance. This is a safe and read-only operation. Do not attempt to run this on a remote Directory Server as this tool needs access to local resources, otherwise the report may be inaccurate.

dsctl get-nsstate

Get the replication nsState in a human readable format Replica DN: The DN of the replication configuration entry Replica Suffix: The replicated suffix Replica ID: The Replica identifier Gen Time The time the CSN generator was created Gen Time String: The time string of generator Gen as CSN: The generation CSN Local Offset: The offset due to the local clock being set back Local Offset String: The offset in a nice human format Remote Offset: The offset due to clock difference with remote systems Remote Offset String: The offset in a nice human format Time Skew: The time skew between this server and its replicas Time Skew String: The time skew in a nice human format Seq Num: The number of multiple csns within a second System Time: The local system time Diff in Seconds: The time difference in seconds from the CSN generator creation to now Diff in days/secs: The time difference broken up into days and seconds Endian: Little/Big Endian

dsctl ldifgen

LDIF generator to make sample LDIF files for testing

dsctl dsrc

Manage the .dsrc file

dsctl cockpit

Enable the Cockpit interface/UI

dsctl dblib

database library (i.e bdb/lmdb) migration

## OPTIONS 'dsctl restart'
usage: dsctl [-v] [-j] [instance] restart [-h]

## OPTIONS 'dsctl start'
usage: dsctl [-v] [-j] [instance] start [-h]

## OPTIONS 'dsctl stop'
usage: dsctl [-v] [-j] [instance] stop [-h]

## OPTIONS 'dsctl status'
usage: dsctl [-v] [-j] [instance] status [-h]

## OPTIONS 'dsctl remove'
usage: dsctl [-v] [-j] [instance] remove [-h] [--do-it]

--do-it

By default we do a dry run. This actually initiates the removal of the instance.

## OPTIONS 'dsctl db2index'
usage: dsctl [-v] [-j] [instance] db2index [-h] [--attr [ATTR ...]] [backend]

backend

The backend to reindex. IE userRoot

--attr [ATTR ...]

The attribute's to reindex. IE --attr aci cn givenname

## OPTIONS 'dsctl db2bak'
usage: dsctl [-v] [-j] [instance] db2bak [-h] [archive]

archive

The destination for the archive. This will be created during the db2bak process.

## OPTIONS 'dsctl db2ldif'
usage: dsctl [-v] [-j] [instance] db2ldif [-h] [--replication] [--encrypted]

backend [ldif]

backend

The backend to output as an LDIF. IE userRoot

ldif

The path to the ldif output location.

--replication

Export replication information, suitable for importing on a new consumer or backups.

--encrypted

Export encrypted attributes

## OPTIONS 'dsctl dbverify'
usage: dsctl [-v] [-j] [instance] dbverify [-h] backend

backend

The backend to verify. IE userRoot

## OPTIONS 'dsctl bak2db'
usage: dsctl [-v] [-j] [instance] bak2db [-h] archive

archive

The archive to restore. This will erase all current server databases.

## OPTIONS 'dsctl ldif2db'
usage: dsctl [-v] [-j] [instance] ldif2db [-h] [--encrypted] backend ldif

backend

The backend to restore from an LDIF. IE userRoot

ldif

The path to the ldif to import

--encrypted

Import encrypted attributes

## OPTIONS 'dsctl backups'
usage: dsctl [-v] [-j] [instance] backups [-h] [--delete DELETE]

--delete DELETE

Delete backup directory

## OPTIONS 'dsctl ldifs'
usage: dsctl [-v] [-j] [instance] ldifs [-h] [--delete DELETE]

--delete DELETE

Delete LDIF file

## OPTIONS 'dsctl tls'
usage: dsctl [-v] [-j] [instance] tls [-h]

{list-ca,list-client-ca,show-server-cert,show-cert,generate-server-cert-csr,import-client-ca,import-ca,import-server-cert,import-server-key-cert,remove-cert,export-cert}

...

### Sub-commands
dsctl tls list-ca

list server certificate authorities including intermediates

dsctl tls list-client-ca

list client certificate authorities including intermediates

dsctl tls show-server-cert

Show the active server certificate that clients will see and verify

dsctl tls show-cert

Show a certificate's details referenced by it's nickname. This is analogous to certutil -L -d <path> -n <nickname>

dsctl tls generate-server-cert-csr

Generate a Server-Cert certificate signing request - the csr is then submitted to a CA for verification, and when signed you import with import-ca and import-server-cert

dsctl tls import-client-ca

Import a CA trusted to issue user (client) certificates. This is part of how client certificate authentication functions.

dsctl tls import-ca

Import a CA or intermediate CA for signing this servers certificates (aka Server-Cert). You should import all the CA's in the chain as required. PEM bundles are accepted

dsctl tls import-server-cert

Import a new Server-Cert after the csr has been signed from a CA.

dsctl tls import-server-key-cert

Import a new key and Server-Cert after having been signed from a CA. This is used if you have an external csr tool or a service like lets encrypt that generates PEM keys externally.

dsctl tls remove-cert

Delete a certificate from this database. This will remove it from acting as a CA, a client CA or the Server-Cert role.

dsctl tls export-cert

Export a certificate to PEM or DER/Binary format. PEM format is the default

## OPTIONS 'dsctl tls list-ca'
usage: dsctl [-v] [-j] [instance] tls list-ca [-h]

## OPTIONS 'dsctl tls list-client-ca'
usage: dsctl [-v] [-j] [instance] tls list-client-ca [-h]

## OPTIONS 'dsctl tls show-server-cert'
usage: dsctl [-v] [-j] [instance] tls show-server-cert [-h]

## OPTIONS 'dsctl tls show-cert'
usage: dsctl [-v] [-j] [instance] tls show-cert [-h] nickname

nickname

The nickname (friendly name) of the certificate to display

## OPTIONS 'dsctl tls generate-server-cert-csr'
usage: dsctl [-v] [-j] [instance] tls generate-server-cert-csr

[-h] [--subject SUBJECT] [alt_names ...]

alt_names

Certificate requests subject alternative names. These are auto-detected if not provided

--subject SUBJECT, -s SUBJECT

Certificate Subject field to use

## OPTIONS 'dsctl tls import-client-ca'
usage: dsctl [-v] [-j] [instance] tls import-client-ca [-h] cert_path nickname

cert_path

The path to the x509 cert to import as a client trust root

nickname

The name of the certificate once imported

## OPTIONS 'dsctl tls import-ca'
usage: dsctl [-v] [-j] [instance] tls import-ca [-h]

cert_path nickname

[nickname ...]

cert_path

The path to the x509 cert to import as a server CA

nickname

The name of the certificate once imported

## OPTIONS 'dsctl tls import-server-cert'
usage: dsctl [-v] [-j] [instance] tls import-server-cert [-h] cert_path

cert_path

The path to the x509 cert to import as Server-Cert

## OPTIONS 'dsctl tls import-server-key-cert'
usage: dsctl [-v] [-j] [instance] tls import-server-key-cert

[-h] cert_path key_path

cert_path

The path to the x509 cert to import as Server-Cert

key_path

The path to the x509 key to import associated to Server-Cert

## OPTIONS 'dsctl tls remove-cert'
usage: dsctl [-v] [-j] [instance] tls remove-cert [-h] nickname

nickname

The name of the certificate to delete

## OPTIONS 'dsctl tls export-cert'
usage: dsctl [-v] [-j] [instance] tls export-cert [-h] [--binary-format]

[--output-file OUTPUT_FILE]

nickname

nickname

The name of the certificate to export

--binary-format

Export certificate in DER/binary format

--output-file OUTPUT_FILE

The name for the exported certificate. Default name is the certificate nickname with an extension of ".pem" or ".crt"

## OPTIONS 'dsctl healthcheck'
usage: dsctl [instance] healthcheck [-h] [--list-checks] [--list-errors]

[--dry-run] [--check CHECK [CHECK ...]]

--list-checks

List of known checks

--list-errors

List of known error codes

--dry-run

Do not execute the actual check, only list what would be done

--check CHECK [CHECK ...]

Areas to check. These can be obtained by --list-checks. Every element on the left of the colon (:) may be replaced by an asterisk if multiple options on the right are available.

## OPTIONS 'dsctl get-nsstate'
usage: dsctl [instance] get-nsstate [-h] [--suffix SUFFIX] [--flip FLIP]

--suffix SUFFIX

The DN of the replication suffix to read the state from

--flip FLIP

Flip between Little/Big Endian, this might be required for certain architectures

## OPTIONS 'dsctl ldifgen'
usage: dsctl [-v] [-j] [instance] ldifgen [-h]

{users,groups,cos-def,cos-template,roles,mod-load,nested}

...

### Sub-commands
dsctl ldifgen users

Generate a LDIF containing user entries

dsctl ldifgen groups

Generate a LDIF containing groups and members

dsctl ldifgen cos-def

Generate a LDIF containing a COS definition (classic, pointer, or indirect)

dsctl ldifgen cos-template

Generate a LDIF containing a COS template

dsctl ldifgen roles

Generate a LDIF containing a role entry (managed, filtered, or indirect)

dsctl ldifgen mod-load

Generate a LDIF containing modify operations. This is intended to be consumed by ldapmodify.

dsctl ldifgen nested

Generate a heavily nested database LDIF in a cascading/fractal tree design

## OPTIONS 'dsctl ldifgen users'
usage: dsctl [-v] [-j] [instance] ldifgen users [-h] [--number NUMBER]

[--suffix SUFFIX]

[--parent PARENT] [--generic]

[--start-idx START_IDX]

[--rdn-cn] [--localize]

[--ldif-file LDIF_FILE]

--number NUMBER

The number of users to create.

--suffix SUFFIX

The database suffix where the entries will be created.

--parent PARENT

The parent entry that the user entries should be created under. If not specified, the entries are stored under random Organizational Units.

--generic

Create generic entries in the format of "uid=user####". These entries are also compatible with ldclt.

--start-idx START_IDX

For generic LDIF's you can choose the starting index for the user entries. The default is "0".

--rdn-cn

Use the attribute "cn" as the RDN attribute in the DN instead of "uid"

--localize

Localize the LDIF data

--ldif-file LDIF_FILE

The LDIF file name. Default location is the server's LDIF directory using the name 'ldifgen.ldif'

## OPTIONS 'dsctl ldifgen groups'
usage: dsctl [-v] [-j] [instance] ldifgen groups [-h] [--number NUMBER]

[--suffix SUFFIX]

[--parent PARENT]

[--num-members NUM_MEMBERS]

[--create-members]

[--member-parent MEMBER_PARENT]

[--member-attr MEMBER_ATTR]

[--ldif-file LDIF_FILE]

NAME

NAME

The group name.

--number NUMBER

The number of groups to create.

--suffix SUFFIX

The database suffix where the groups will be created.

--parent PARENT

The parent entry that the group entries should be created under. If not specified the groups are stored under the suffix.

--num-members NUM_MEMBERS

The number of members in the group. Default is 10000

--create-members

Create the member user entries.

--member-parent MEMBER_PARENT

The entry DN that the members should be created under. The default is the suffix entry.

--member-attr MEMBER_ATTR

The membership attribute to use in the group. Default is "uniquemember".

--ldif-file LDIF_FILE

The LDIF file name. Default location is the server's LDIF directory using the name 'ldifgen.ldif'

## OPTIONS 'dsctl ldifgen cos-def'
usage: dsctl [-v] [-j] [instance] ldifgen cos-def [-h] [--type TYPE]

[--parent PARENT]

[--create-parent]

[--cos-specifier COS_SPECIFIER]

[--cos-template COS_TEMPLATE]

[--cos-attr [COS_ATTR ...]]

[--ldif-file LDIF_FILE]

NAME

NAME

The COS definition name.

--type TYPE

The COS definition type: "classic", "pointer", or "indirect".

--parent PARENT

The parent entry that the COS definition should be created under.

--create-parent

Create the parent entry

--cos-specifier COS_SPECIFIER

Used in a classic COS definition, this attribute located in the user entry is used to select which COS template to use.

--cos-template COS_TEMPLATE

The DN of the COS template entry, only used for "classic" and "pointer" COS definitions.

--cos-attr [COS_ATTR ...]

A list of attributes which defines which attribute the COS generates values for.

--ldif-file LDIF_FILE

The LDIF file name. Default location is the server's LDIF directory using the name 'ldifgen.ldif'

## OPTIONS 'dsctl ldifgen cos-template'
usage: dsctl [-v] [-j] [instance] ldifgen cos-template [-h] [--parent PARENT]

[--create-parent]

[--cos-priority COS_PRIORITY]

[--cos-attr-val COS_ATTR_VAL]

[--ldif-file LDIF_FILE]

NAME

NAME

The COS template name.

--parent PARENT

The DN of the entry to store the COS template entry under.

--create-parent

Create the parent entry

--cos-priority COS_PRIORITY

Sets the priority of this conflicting/competing COS templates.

--cos-attr-val COS_ATTR_VAL

defines the attribute and value that the template provides.

--ldif-file LDIF_FILE

The LDIF file name. Default location is the server's LDIF directory using the name 'ldifgen.ldif'

## OPTIONS 'dsctl ldifgen roles'
usage: dsctl [-v] [-j] [instance] ldifgen roles [-h] [--type TYPE]

[--parent PARENT]

[--create-parent]

[--filter FILTER]

[--role-dn [ROLE_DN ...]]

[--ldif-file LDIF_FILE]

NAME

NAME

The Role name.

--type TYPE

The Role type: "managed", "filtered", or "nested".

--parent PARENT

The DN of the entry to store the Role entry under

--create-parent

Create the parent entry

--filter FILTER

A search filter for gathering Role members. Required for a "filtered" role.

--role-dn [ROLE_DN ...]

A DN of a role entry that should be included in this role. Used for "nested" roles only.

--ldif-file LDIF_FILE

The LDIF file name. Default location is the server's LDIF directory using the name 'ldifgen.ldif'

## OPTIONS 'dsctl ldifgen mod-load'
usage: dsctl [-v] [-j] [instance] ldifgen mod-load [-h] [--create-users]

[--delete-users]

[--num-users NUM_USERS]

[--parent PARENT]

[--create-parent]

[--add-users ADD_USERS]

[--del-users DEL_USERS]

[--modrdn-users MODRDN_USERS]

[--mod-users MOD_USERS]

[--mod-attrs [MOD_ATTRS ...]]

[--randomize]

[--ldif-file LDIF_FILE]

--create-users

Create the entries that will be modified or deleted. By default the script assumes the user entries already exist.

--delete-users

Delete all the user entries at the end of the LDIF.

--num-users NUM_USERS

The number of user entries that will be modified or deleted

--parent PARENT

The DN of the parent entry where the user entries are located.

--create-parent

Create the parent entry

--add-users ADD_USERS

The number of additional entries to add during the load.

--del-users DEL_USERS

The number of entries to delete during the load.

--modrdn-users MODRDN_USERS

The number of entries to perform a modrdn operation on.

--mod-users MOD_USERS

The number of entries to modify.

--mod-attrs [MOD_ATTRS ...]

List of attributes the script will randomly choose from when modifying an entry. The default is "description".

--randomize

Randomly perform the specified add, mod, delete, and modrdn operations

--ldif-file LDIF_FILE

The LDIF file name. Default location is the server's LDIF directory using the name 'ldifgen.ldif'

## OPTIONS 'dsctl ldifgen nested'
usage: dsctl [-v] [-j] [instance] ldifgen nested [-h] [--num-users NUM_USERS]

[--node-limit NODE_LIMIT]

[--suffix SUFFIX]

[--ldif-file LDIF_FILE]

--num-users NUM_USERS

The total number of user entries to create in the entire LDIF (does not include the container entries).

--node-limit NODE_LIMIT

The total number of user entries to create under each node/subtree

--suffix SUFFIX

The suffix DN for the LDIF

--ldif-file LDIF_FILE

The LDIF file name. Default location is the server's LDIF directory using the name 'ldifgen.ldif'

## OPTIONS 'dsctl dsrc'
usage: dsctl [-v] [-j] [instance] dsrc [-h] {create,modify,delete,display,repl-mon} ...

### Sub-commands
dsctl dsrc create

Generate the .dsrc file

dsctl dsrc modify

Modify the .dsrc file

dsctl dsrc delete

Delete instance configuration from the .dsrc file.

dsctl dsrc display

Display the contents of the .dsrc file.

dsctl dsrc repl-mon

Display the contents of the .dsrc file.

## OPTIONS 'dsctl dsrc create'
usage: dsctl [-v] [-j] [instance] dsrc create [-h] [--uri URI]

[--basedn BASEDN]

[--people-rdn PEOPLE_RDN]

[--groups-rdn GROUPS_RDN]

[--binddn BINDDN]

[--saslmech SASLMECH]

[--tls-cacertdir TLS_CACERTDIR]

[--tls-cert TLS_CERT]

[--tls-key TLS_KEY]

[--tls-reqcert TLS_REQCERT]

[--starttls] [--pwdfile PWDFILE]

[--do-it]

--uri URI

The URI (LDAP URL) for the Directory Server instance.

--basedn BASEDN

The default database suffix.

--people-rdn PEOPLE_RDN

Set the RDN for the 'people' subtree. Default is "ou=people"

--groups-rdn GROUPS_RDN

Set the RDN for the 'groups' subtree. Default is "ou=groups"

--binddn BINDDN

The default Bind DN used or authentication.

--saslmech SASLMECH

The SASL mechanism to use: PLAIN or EXTERNAL.

--tls-cacertdir TLS_CACERTDIR

The directory containing the Trusted Certificate Authority certificate.

--tls-cert TLS_CERT

The absolute file name to the server certificate.

--tls-key TLS_KEY

The absolute file name to the server certificate key.

--tls-reqcert TLS_REQCERT

Request certificate strength: 'never', 'allow', 'hard'

--starttls

Use startTLS for connection to the server.

--pwdfile PWDFILE

The absolute path to a file containing the Bind DN's password.

--do-it

Create the file without any confirmation.

## OPTIONS 'dsctl dsrc modify'
usage: dsctl [-v] [-j] [instance] dsrc modify [-h] [--uri [URI]]

[--basedn [BASEDN]]

[--people-rdn [PEOPLE_RDN]]

[--groups-rdn [GROUPS_RDN]]

[--binddn [BINDDN]]

[--saslmech [SASLMECH]]

[--tls-cacertdir [TLS_CACERTDIR]]

[--tls-cert [TLS_CERT]]

[--tls-key [TLS_KEY]]

[--tls-reqcert [TLS_REQCERT]]

[--starttls] [--cancel-starttls]

[--pwdfile [PWDFILE]] [--do-it]

--uri [URI]

The URI (LDAP URL) for the Directory Server instance.

--basedn [BASEDN]

The default database suffix.

--people-rdn [PEOPLE_RDN]

Sets the RDN used for the 'people' container

--groups-rdn [GROUPS_RDN]

Sets the RDN used for the 'groups' container

--binddn [BINDDN]

The default Bind DN used or authentication.

--saslmech [SASLMECH]

The SASL mechanism to use: PLAIN or EXTERNAL.

--tls-cacertdir [TLS_CACERTDIR]

The directory containing the Trusted Certificate Authority certificate.

--tls-cert [TLS_CERT]

The absolute file name to the server certificate.

--tls-key [TLS_KEY]

The absolute file name to the server certificate key.

--tls-reqcert [TLS_REQCERT]

Request certificate strength: 'never', 'allow', 'hard'

--starttls

Use startTLS for connection to the server.

--cancel-starttls

Do not use startTLS for connection to the server.

--pwdfile [PWDFILE]

The absolute path to a file containing the Bind DN's password.

--do-it

Update the file without any confirmation.

## OPTIONS 'dsctl dsrc delete'
usage: dsctl [-v] [-j] [instance] dsrc delete [-h] [--do-it]

--do-it

Delete this instance's configuration from the .dsrc file.

## OPTIONS 'dsctl dsrc display'
usage: dsctl [-v] [-j] [instance] dsrc display [-h]

## OPTIONS 'dsctl dsrc repl-mon'
usage: dsctl [-v] [-j] [instance] dsrc repl-mon [-h]

[--add-conn ADD_CONN [ADD_CONN ...]]

[--del-conn DEL_CONN [DEL_CONN ...]]

[--add-alias ADD_ALIAS [ADD_ALIAS ...]]

[--del-alias DEL_ALIAS [DEL_ALIAS ...]]

--add-conn ADD_CONN [ADD_CONN ...]

Add a replica connection: 'NAME:HOST:PORT:BINDDN:CREDENTIAL'

--del-conn DEL_CONN [DEL_CONN ...]

delete a replica connection by its NAME

--add-alias ADD_ALIAS [ADD_ALIAS ...]

Add a host/port alias: 'ALIAS_NAME:HOST:PORT'

--del-alias DEL_ALIAS [DEL_ALIAS ...]

delete a host/port alias by its ALIAS_NAME

## OPTIONS 'dsctl cockpit'
usage: dsctl [-v] [-j] [instance] cockpit [-h]

{enable,open-firewall,disable,close-firewall}

...

### Sub-commands
dsctl cockpit enable

Enable the Cockpit socket

dsctl cockpit open-firewall

Open the firewall for the "cockpit" service

dsctl cockpit disable

Disable the Cockpit socket

dsctl cockpit close-firewall

Remove the "cockpit" service from the firewall settings

## OPTIONS 'dsctl cockpit enable'
usage: dsctl [-v] [-j] [instance] cockpit enable [-h]

## OPTIONS 'dsctl cockpit open-firewall'
usage: dsctl [-v] [-j] [instance] cockpit open-firewall [-h] [--zone ZONE]

--zone ZONE

The firewall zone

## OPTIONS 'dsctl cockpit disable'
usage: dsctl [-v] [-j] [instance] cockpit disable [-h]

## OPTIONS 'dsctl cockpit close-firewall'
usage: dsctl [-v] [-j] [instance] cockpit close-firewall [-h]

## OPTIONS 'dsctl dblib'
usage: dsctl [-v] [-j] [instance] dblib [-h] {bdb2mdb,mdb2bdb,cleanup} ...

### Sub-commands
dsctl dblib bdb2mdb

Migrate bdb databases to lmdb

dsctl dblib mdb2bdb

Migrate lmdb databases to bdb

dsctl dblib cleanup

Remove migration ldif file and old database

## OPTIONS 'dsctl dblib bdb2mdb'
usage: dsctl [-v] [-j] [instance] dblib bdb2mdb [-h] [--tmpdir TMPDIR]

--tmpdir TMPDIR

ldif migration files directory path.

## OPTIONS 'dsctl dblib mdb2bdb'
usage: dsctl [-v] [-j] [instance] dblib mdb2bdb [-h] [--tmpdir TMPDIR]

--tmpdir TMPDIR

ldif migration files directory path.

## OPTIONS 'dsctl dblib cleanup'
usage: dsctl [-v] [-j] [instance] dblib cleanup [-h]

-v, --verbose

Display verbose operation tracing during command execution

-j, --json

Return result in JSON object

-l, --list

List available Directory Server instances

## AUTHORS
lib389 was written by Red Hat, Inc., and William Brown <389-devel@lists.fedoraproject.org>.

## DISTRIBUTION
The latest version of lib389 may be downloaded from http://www.port389.org/docs/389ds/FAQ/upstream-test-framework.html


dsidm

title: dsidm(8)

text:
# dsidm(8)

## NAME
dsidm

## SYNOPSIS
dsidm [-h] [-v] [-j] [-b BASEDN] [-D BINDDN] [-w BINDPW] [-W] [-y PWDFILE] [-Z] instance {account,group,initialise,init,organizationalunit,ou,posixgroup,user,client_config,role,service,uniquegroup} ...

## OPTIONS
instance

The name of the instance or its LDAP URL, such as ldap://server.example.com:389

### Sub-commands
dsidm account

Manage generic accounts, with tasks like modify, locking and unlocking. To create an account, see "user" subcommand instead.

dsidm group

Manage groups. The organizationalUnit (by default "ou=groups") needs to exist prior to managing groups. Groups uses the objectclass "groupOfNames" and the grouping attribute "member"

dsidm initialise

Initialise a backend with domain information and sample entries

dsidm organizationalunit

Manage organizational units

dsidm posixgroup

Manage posix groups The organizationalUnit (by default ou=groups") needs to exist prior to managing posix groups.

dsidm user

Manage posix users. The organizationalUnit (by default "ou=people") needs to exist prior to managing users.

dsidm client_config

Display and generate client example configs for this LDAP server

dsidm role

Manage roles.

dsidm service

Manage service accounts. The organizationalUnit (by default "ou=Services") needs to exist prior to managing service accounts.

dsidm uniquegroup

Manage groups. The organizationalUnit (by default "ou=groups") needs to exist prior to managing groups. Unique groups uses the objectclass "groupOfUniqueNames" and the grouping attribute "uniquemember"

## OPTIONS 'dsidm account'
usage: dsidm instance account [-h]

{list,get-by-dn,modify-by-dn,rename-by-dn,delete,lock,unlock,entry-status,subtree-status,reset_password,change_password,bulk_update}

...

### Sub-commands
dsidm account list

list accounts that could login to the directory

dsidm account get-by-dn

get-by-dn <dn>

dsidm account modify-by-dn

modify-by-dn <dn> <add|delete|replace>:<attribute>:<value> ...

dsidm account rename-by-dn

rename the object

dsidm account delete

deletes the account

dsidm account lock

lock

dsidm account unlock

unlock

dsidm account entry-status

status of a single entry

dsidm account subtree-status

status of a subtree

dsidm account reset_password

Reset the password of an account. This should be performed by a directory admin.

dsidm account change_password

Change the password of an account. This can be performed by any user (with correct rights)

dsidm account bulk_update

Perform a common operation to a set of entries

## OPTIONS 'dsidm account list'
usage: dsidm [-v] [-j] instance account list [-h]

## OPTIONS 'dsidm account get-by-dn'
usage: dsidm [-v] [-j] instance account get-by-dn [-h] [dn]

dn

The dn to get and display

## OPTIONS 'dsidm account modify-by-dn'
usage: dsidm [-v] [-j] instance account modify-by-dn [-h] dn changes [changes ...]

dn

The dn to get and display

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm account rename-by-dn'
usage: dsidm [-v] [-j] instance account rename-by-dn [-h] [--keep-old-rdn] dn new_dn

dn

The dn to rename

new_dn

A new role dn

--keep-old-rdn

Specify whether the old RDN (i.e. 'cn: old_role') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm account delete'
usage: dsidm [-v] [-j] instance account delete [-h] [dn]

dn

The dn of the account to delete

## OPTIONS 'dsidm account lock'
usage: dsidm [-v] [-j] instance account lock [-h] [dn]

dn

The dn to lock

## OPTIONS 'dsidm account unlock'
usage: dsidm [-v] [-j] instance account unlock [-h] [dn]

dn

The dn to unlock

## OPTIONS 'dsidm account entry-status'
usage: dsidm [-v] [-j] instance account entry-status [-h] [-V] [dn]

dn

The single entry dn to check

-V, --details

Print more account policy details about the entry

## OPTIONS 'dsidm account subtree-status'
usage: dsidm [-v] [-j] instance account subtree-status [-h] [-V] [-f FILTER]

[-s {one,sub}] [-i]

[-o BECOME_INACTIVE_ON]

basedn

basedn

Search base for finding entries

-V, --details

Print more account policy details about the entries

-f FILTER, --filter FILTER

Search filter for finding entries

-s {one,sub}, --scope {one,sub}

Search scope (one, sub - default is sub

-i, --inactive-only

Only display inactivated entries

-o BECOME_INACTIVE_ON, --become-inactive-on BECOME_INACTIVE_ON

Only display entries that will become inactive before specified date (in a format 2007-04-25T14:30)

## OPTIONS 'dsidm account reset_password'
usage: dsidm [-v] [-j] instance account reset_password [-h] [dn] [new_password]

dn

The dn to reset the password for

new_password

The new password to set

## OPTIONS 'dsidm account change_password'
usage: dsidm [-v] [-j] instance account change_password [-h]

[dn] [new_password]

[current_password]

dn

The dn to change the password for

new_password

The new password to set

current_password

The accounts current password

## OPTIONS 'dsidm account bulk_update'
usage: dsidm [-v] [-j] instance account bulk_update [-h] [-f FILTER] [-s {one,sub}] [-x]

basedn changes [changes ...]

basedn

Search base for finding entries, only the children of this DN are processed

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

-f FILTER, --filter FILTER

Search filter for finding entries, default is '(objectclass=*)'

-s {one,sub}, --scope {one,sub}

Search scope (one, sub - default is sub

-x, --stop

Stop processing updates when an error occurs. Default is False

## OPTIONS 'dsidm group'
usage: dsidm instance group [-h]

{list,get,get_dn,create,delete,modify,rename,members,add_member,remove_member}

...

### Sub-commands
dsidm group list

list

dsidm group get

get

dsidm group get_dn

get_dn

dsidm group create

create

dsidm group delete

deletes the object

dsidm group modify

modify <add|delete|replace>:<attribute>:<value> ...

dsidm group rename

rename the object

dsidm group members

List member dns of a group

dsidm group add_member

Add a member to a group

dsidm group remove_member

Remove a member from a group

## OPTIONS 'dsidm group list'
usage: dsidm [-v] [-j] instance group list [-h]

## OPTIONS 'dsidm group get'
usage: dsidm [-v] [-j] instance group get [-h] [selector]

selector

The term to search for

## OPTIONS 'dsidm group get_dn'
usage: dsidm [-v] [-j] instance group get_dn [-h] [dn]

dn

The dn to get

## OPTIONS 'dsidm group create'
usage: dsidm [-v] [-j] instance group create [-h] [--cn [CN]]

--cn [CN]

Value of cn

## OPTIONS 'dsidm group delete'
usage: dsidm [-v] [-j] instance group delete [-h] [dn]

dn

The dn to delete

## OPTIONS 'dsidm group modify'
usage: dsidm [-v] [-j] instance group modify [-h] selector changes [changes ...]

selector

The cn to modify

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm group rename'
usage: dsidm [-v] [-j] instance group rename [-h] [--keep-old-rdn] selector new_name

selector

The cn to rename

new_name

A new group name

--keep-old-rdn

Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm group members'
usage: dsidm [-v] [-j] instance group members [-h] [cn]

cn

cn of group to list members of

## OPTIONS 'dsidm group add_member'
usage: dsidm [-v] [-j] instance group add_member [-h] [cn] [dn]

cn

cn of group to add member to

dn

dn of object to add to group as member

## OPTIONS 'dsidm group remove_member'
usage: dsidm [-v] [-j] instance group remove_member [-h] [cn] [dn]

cn

cn of group to remove member from

dn

dn of object to remove from group as member

## OPTIONS 'dsidm initialise'
usage: dsidm [-v] [-j] instance initialise [-h] [--version VERSION]

--version VERSION

The version of entries to create.

## OPTIONS 'dsidm init'
usage: dsidm [-v] [-j] instance initialise [-h] [--version VERSION]

--version VERSION

The version of entries to create.

## OPTIONS 'dsidm organizationalunit'
usage: dsidm [-v] [-j] instance organizationalunit [-h]

{list,get,get_dn,create,delete,modify,rename}

...

### Sub-commands
dsidm organizationalunit list

list

dsidm organizationalunit get

get

dsidm organizationalunit get_dn

get_dn

dsidm organizationalunit create

create

dsidm organizationalunit delete

deletes the object

dsidm organizationalunit modify

modify <add|delete|replace>:<attribute>:<value> ...

dsidm organizationalunit rename

rename the object

## OPTIONS 'dsidm organizationalunit list'
usage: dsidm [-v] [-j] instance organizationalunit list [-h]

## OPTIONS 'dsidm organizationalunit get'
usage: dsidm [-v] [-j] instance organizationalunit get [-h] [selector]

selector

The term to search for

## OPTIONS 'dsidm organizationalunit get_dn'
usage: dsidm [-v] [-j] instance organizationalunit get_dn [-h] [dn]

dn

The dn to get

## OPTIONS 'dsidm organizationalunit create'
usage: dsidm [-v] [-j] instance organizationalunit create [-h] [--ou [OU]]

--ou [OU]

Value of ou

## OPTIONS 'dsidm organizationalunit delete'
usage: dsidm [-v] [-j] instance organizationalunit delete [-h] [dn]

dn

The dn to delete

## OPTIONS 'dsidm organizationalunit modify'
usage: dsidm [-v] [-j] instance organizationalunit modify [-h]

selector changes

[changes ...]

selector

The ou to modify

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm organizationalunit rename'
usage: dsidm [-v] [-j] instance organizationalunit rename [-h]

[--keep-old-rdn]

selector new_name

selector

The ou to rename

new_name

A new organizational unit name

--keep-old-rdn

Specify whether the old RDN (i.e. 'ou: old_ou') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm ou'
usage: dsidm [-v] [-j] instance organizationalunit [-h]

{list,get,get_dn,create,delete,modify,rename}

...

### Sub-commands
dsidm ou list

list

dsidm ou get

get

dsidm ou get_dn

get_dn

dsidm ou create

create

dsidm ou delete

deletes the object

dsidm ou modify

modify <add|delete|replace>:<attribute>:<value> ...

dsidm ou rename

rename the object

## OPTIONS 'dsidm ou list'
usage: dsidm [-v] [-j] instance organizationalunit list [-h]

## OPTIONS 'dsidm ou get'
usage: dsidm [-v] [-j] instance organizationalunit get [-h] [selector]

selector

The term to search for

## OPTIONS 'dsidm ou get_dn'
usage: dsidm [-v] [-j] instance organizationalunit get_dn [-h] [dn]

dn

The dn to get

## OPTIONS 'dsidm ou create'
usage: dsidm [-v] [-j] instance organizationalunit create [-h] [--ou [OU]]

--ou [OU]

Value of ou

## OPTIONS 'dsidm ou delete'
usage: dsidm [-v] [-j] instance organizationalunit delete [-h] [dn]

dn

The dn to delete

## OPTIONS 'dsidm ou modify'
usage: dsidm [-v] [-j] instance organizationalunit modify [-h]

selector changes

[changes ...]

selector

The ou to modify

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm ou rename'
usage: dsidm [-v] [-j] instance organizationalunit rename [-h]

[--keep-old-rdn]

selector new_name

selector

The ou to rename

new_name

A new organizational unit name

--keep-old-rdn

Specify whether the old RDN (i.e. 'ou: old_ou') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm posixgroup'
usage: dsidm instance posixgroup [-h]

{list,get,get_dn,create,delete,modify,rename}

...

### Sub-commands
dsidm posixgroup list

list

dsidm posixgroup get

get

dsidm posixgroup get_dn

get_dn

dsidm posixgroup create

create

dsidm posixgroup delete

deletes the object

dsidm posixgroup modify

modify <add|delete|replace>:<attribute>:<value> ...

dsidm posixgroup rename

rename the object

## OPTIONS 'dsidm posixgroup list'
usage: dsidm [-v] [-j] instance posixgroup list [-h]

## OPTIONS 'dsidm posixgroup get'
usage: dsidm [-v] [-j] instance posixgroup get [-h] [selector]

selector

The term to search for

## OPTIONS 'dsidm posixgroup get_dn'
usage: dsidm [-v] [-j] instance posixgroup get_dn [-h] [dn]

dn

The dn to get

## OPTIONS 'dsidm posixgroup create'
usage: dsidm [-v] [-j] instance posixgroup create [-h] [--cn [CN]]

[--gidNumber [GIDNUMBER]]

--cn [CN]

Value of cn

--gidNumber [GIDNUMBER]

Value of gidNumber

## OPTIONS 'dsidm posixgroup delete'
usage: dsidm [-v] [-j] instance posixgroup delete [-h] [dn]

dn

The dn to delete

## OPTIONS 'dsidm posixgroup modify'
usage: dsidm [-v] [-j] instance posixgroup modify [-h] selector changes [changes ...]

selector

The cn to modify

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm posixgroup rename'
usage: dsidm [-v] [-j] instance posixgroup rename [-h] [--keep-old-rdn]

selector new_name

selector

The cn to rename

new_name

A new posix group name

--keep-old-rdn

Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm user'
usage: dsidm instance user [-h]

{list,get,get_dn,create,modify,rename,delete} ...

### Sub-commands
dsidm user list

list

dsidm user get

get

dsidm user get_dn

get_dn

dsidm user create

create

dsidm user modify

modify <add|delete|replace>:<attribute>:<value> ...

dsidm user rename

rename the object

dsidm user delete

deletes the object

## OPTIONS 'dsidm user list'
usage: dsidm [-v] [-j] instance user list [-h]

## OPTIONS 'dsidm user get'
usage: dsidm [-v] [-j] instance user get [-h] [selector]

selector

The term to search for

## OPTIONS 'dsidm user get_dn'
usage: dsidm [-v] [-j] instance user get_dn [-h] [dn]

dn

The dn to get

## OPTIONS 'dsidm user create'
usage: dsidm [-v] [-j] instance user create [-h] [--uid [UID]] [--cn [CN]]

[--displayName [DISPLAYNAME]]

[--uidNumber [UIDNUMBER]]

[--gidNumber [GIDNUMBER]]

[--homeDirectory [HOMEDIRECTORY]]

--uid [UID]

Value of uid

--cn [CN]

Value of cn

--displayName [DISPLAYNAME]

Value of displayName

--uidNumber [UIDNUMBER]

Value of uidNumber

--gidNumber [GIDNUMBER]

Value of gidNumber

--homeDirectory [HOMEDIRECTORY]

Value of homeDirectory

## OPTIONS 'dsidm user modify'
usage: dsidm [-v] [-j] instance user modify [-h] selector changes [changes ...]

selector

The uid to modify

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm user rename'
usage: dsidm [-v] [-j] instance user rename [-h] [--keep-old-rdn] selector new_name

selector

The uid to modify

new_name

A new user name

--keep-old-rdn

Specify whether the old RDN (i.e. 'cn: old_user') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm user delete'
usage: dsidm [-v] [-j] instance user delete [-h] [dn]

dn

The dn to delete

## OPTIONS 'dsidm client_config'
usage: dsidm instance client_config [-h] {sssd.conf,ldap.conf,display} ...

### Sub-commands
dsidm client_config sssd.conf

Generate a SSSD configuration for this LDAP server

dsidm client_config ldap.conf

Generate an OpenLDAP ldap.conf configuration for this LDAP server

dsidm client_config display

Display generic application parameters for LDAP connection

## OPTIONS 'dsidm client_config sssd.conf'
usage: dsidm instance client_config sssd.conf [-h] [allowed_group]

allowed_group

The name of the group allowed access to this system

## OPTIONS 'dsidm client_config ldap.conf'
usage: dsidm instance client_config ldap.conf [-h]

## OPTIONS 'dsidm client_config display'
usage: dsidm instance client_config display [-h]

## OPTIONS 'dsidm role'
usage: dsidm [-v] [-j] instance role [-h]

{list,get,get-by-dn,create-managed,create-filtered,create-nested,modify-by-dn,rename-by-dn,delete,lock,unlock,entry-status,subtree-status}

...

### Sub-commands
dsidm role list

list roles that could login to the directory

dsidm role get

get

dsidm role get-by-dn

get-by-dn <dn>

dsidm role create-managed

create

dsidm role create-filtered

create

dsidm role create-nested

create

dsidm role modify-by-dn

modify-by-dn <dn> <add|delete|replace>:<attribute>:<value> ...

dsidm role rename-by-dn

rename the object

dsidm role delete

deletes the role

dsidm role lock

lock

dsidm role unlock

unlock

dsidm role entry-status

status of a single entry

dsidm role subtree-status

status of a subtree

## OPTIONS 'dsidm role list'
usage: dsidm [-v] [-j] instance role list [-h]

## OPTIONS 'dsidm role get'
usage: dsidm [-v] [-j] instance role get [-h] [selector]

selector

The term to search for

## OPTIONS 'dsidm role get-by-dn'
usage: dsidm [-v] [-j] instance role get-by-dn [-h] [dn]

dn

The dn to get and display

## OPTIONS 'dsidm role create-managed'
usage: dsidm [-v] [-j] instance role create-managed [-h] [--cn [CN]]

--cn [CN]

Value of cn

## OPTIONS 'dsidm role create-filtered'
usage: dsidm [-v] [-j] instance role create-filtered [-h] [--cn [CN]]

--cn [CN]

Value of cn

## OPTIONS 'dsidm role create-nested'
usage: dsidm [-v] [-j] instance role create-nested [-h] [--cn [CN]]

[--nsRoleDN [NSROLEDN]]

--cn [CN]

Value of cn

--nsRoleDN [NSROLEDN]

Value of nsRoleDN

## OPTIONS 'dsidm role modify-by-dn'
usage: dsidm [-v] [-j] instance role modify-by-dn [-h]

dn changes [changes ...]

dn

The dn to modify

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm role rename-by-dn'
usage: dsidm [-v] [-j] instance role rename-by-dn [-h] [--keep-old-rdn]

dn new_dn

dn

The dn to rename

new_dn

A new account dn

--keep-old-rdn

Specify whether the old RDN (i.e. 'cn: old_account') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm role delete'
usage: dsidm [-v] [-j] instance role delete [-h] [dn]

dn

The dn of the role to delete

## OPTIONS 'dsidm role lock'
usage: dsidm [-v] [-j] instance role lock [-h] [dn]

dn

The dn to lock

## OPTIONS 'dsidm role unlock'
usage: dsidm [-v] [-j] instance role unlock [-h] [dn]

dn

The dn to unlock

## OPTIONS 'dsidm role entry-status'
usage: dsidm [-v] [-j] instance role entry-status [-h] [dn]

dn

The single entry dn to check

## OPTIONS 'dsidm role subtree-status'
usage: dsidm [-v] [-j] instance role subtree-status [-h] [-f FILTER]

[-s {base,one,sub}]

basedn

basedn

Search base for finding entries

-f FILTER, --filter FILTER

Search filter for finding entries

-s {base,one,sub}, --scope {base,one,sub}

Search scope (base, one, sub - default is sub

## OPTIONS 'dsidm service'
usage: dsidm [-v] [-j] instance service [-h]

{list,get,get_dn,create,modify,rename,delete}

...

### Sub-commands
dsidm service list

list

dsidm service get

get

dsidm service get_dn

get_dn

dsidm service create

create

dsidm service modify

modify <add|delete|replace>:<attribute>:<value> ...

dsidm service rename

rename the object

dsidm service delete

deletes the object

## OPTIONS 'dsidm service list'
usage: dsidm [-v] [-j] instance service list [-h]

## OPTIONS 'dsidm service get'
usage: dsidm [-v] [-j] instance service get [-h] [selector]

selector

The term to search for

## OPTIONS 'dsidm service get_dn'
usage: dsidm [-v] [-j] instance service get_dn [-h] [dn]

dn

The dn to get

## OPTIONS 'dsidm service create'
usage: dsidm [-v] [-j] instance service create [-h] [--cn [CN]]

[--description [DESCRIPTION]]

--cn [CN]

Value of cn

--description [DESCRIPTION]

Value of description

## OPTIONS 'dsidm service modify'
usage: dsidm [-v] [-j] instance service modify [-h]

selector changes [changes ...]

selector

The cn to modify

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm service rename'
usage: dsidm [-v] [-j] instance service rename [-h] [--keep-old-rdn]

selector new_name

selector

The cn to modify

new_name

A new service name

--keep-old-rdn

Specify whether the old RDN (i.e. 'cn: old_service') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm service delete'
usage: dsidm [-v] [-j] instance service delete [-h] [dn]

dn

The dn to delete

## OPTIONS 'dsidm uniquegroup'
usage: dsidm instance uniquegroup [-h]

{list,get,get_dn,create,delete,modify,rename,members,add_member,remove_member}

...

### Sub-commands
dsidm uniquegroup list

list

dsidm uniquegroup get

get

dsidm uniquegroup get_dn

get_dn

dsidm uniquegroup create

create

dsidm uniquegroup delete

deletes the object

dsidm uniquegroup modify

modify <add|delete|replace>:<attribute>:<value> ...

dsidm uniquegroup rename

rename the object

dsidm uniquegroup members

List member dns of a group

dsidm uniquegroup add_member

Add a member to a group

dsidm uniquegroup remove_member

Remove a member from a group

## OPTIONS 'dsidm uniquegroup list'
usage: dsidm [-v] [-j] instance uniquegroup list [-h]

## OPTIONS 'dsidm uniquegroup get'
usage: dsidm [-v] [-j] instance uniquegroup get [-h] [selector]

selector

The term to search for

## OPTIONS 'dsidm uniquegroup get_dn'
usage: dsidm [-v] [-j] instance uniquegroup get_dn [-h] [dn]

dn

The dn to get

## OPTIONS 'dsidm uniquegroup create'
usage: dsidm [-v] [-j] instance uniquegroup create [-h] [--cn [CN]]

--cn [CN]

Value of cn

## OPTIONS 'dsidm uniquegroup delete'
usage: dsidm [-v] [-j] instance uniquegroup delete [-h] [dn]

dn

The dn to delete

## OPTIONS 'dsidm uniquegroup modify'
usage: dsidm [-v] [-j] instance uniquegroup modify [-h] selector changes [changes ...]

selector

The cn to modify

changes

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

## OPTIONS 'dsidm uniquegroup rename'
usage: dsidm [-v] [-j] instance uniquegroup rename [-h] [--keep-old-rdn]

selector new_name

selector

The cn to rename

new_name

A new group name

--keep-old-rdn

Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an attribute of the entry or not

## OPTIONS 'dsidm uniquegroup members'
usage: dsidm [-v] [-j] instance uniquegroup members [-h] [cn]

cn

cn of group to list members of

## OPTIONS 'dsidm uniquegroup add_member'
usage: dsidm [-v] [-j] instance uniquegroup add_member [-h] [cn] [dn]

cn

cn of group to add member to

dn

dn of object to add to group as member

## OPTIONS 'dsidm uniquegroup remove_member'
usage: dsidm [-v] [-j] instance uniquegroup remove_member [-h] [cn] [dn]

cn

cn of group to remove member from

dn

dn of object to remove from group as member

-v, --verbose

Display verbose operation tracing during command execution

-j, --json

Return result in JSON object

-b BASEDN, --basedn BASEDN

Base DN (root naming context) of the instance to manage

-D BINDDN, --binddn BINDDN

The account to bind as for executing operations

-w BINDPW, --bindpw BINDPW

Password for the bind DN

-W, --prompt

Prompt for password of the bind DN

-y PWDFILE, --pwdfile PWDFILE

Specifies a file containing the password of the bind DN

-Z, --starttls

Connect with StartTLS

## AUTHORS
lib389 was written by Red Hat, Inc., and William Brown <389-devel@lists.fedoraproject.org>.

## DISTRIBUTION
The latest version of lib389 may be downloaded from http://www.port389.org/docs/389ds/FAQ/upstream-test-framework.html


title: pcs_snmp_agent(8)

text:
# pcs_snmp_agent(8)

## NAME
pcs_snmp_agent - a SNMP agent providing data about a corosync/pacemaker cluster

## DESCRIPTION
pcs_snmp_agent is a SNMP agent which connects to the master agent (snmpd) via agentx protocol and provides information about a corosync/pacemaker cluster.

## SETUP
pcs_snmp_agent doesn't work as a standalone agent. It only provides data to a master agent. To configure a snmpd daemon (from package net-snmp) as the master agent, add line 'master agentx' into the snmpd configuration file (see snmp.conf(5)). Then master agent has to be configured to accepts requests for pcs defined MIBs. This can be done by adding line 'view systemview included .1.3.6.1.4.1.32723.100' into the snmpd config file.

## MIB DATA VERSIONS
V1 - REDHAT-CLUSTER-PCS-V1-MIB

Provides basic information about cluster such as cluster name, list of cluster nodes and list of primitive resources.

## ENVIRONMENT
PCS_SNMP_AGENT_DEBUG=<boolean>

Set to true for advanced debugging information.

PCS_SNMP_AGENT_UPDATE_INTERVAL=<integer>

Time interval in seconds after which agent will update provided data.

## SEE ALSO
pcs(8) pcsd(8)

snmpd(8) snmp.conf(5)


qemu-ga

package: qemu-guest-agent

title: qemu-ga(8)

summary: QEMU Guest Agent

text:
# qemu-ga(8)

## NAME
qemu-ga - QEMU Guest Agent

## SYNOPSIS
qemu-ga [OPTIONS]

## DESCRIPTION
The QEMU Guest Agent is a daemon intended to be run within virtual machines. It allows the hypervisor host to perform various operations in the guest, such as:

- get information from the guest

- set the guest's system time

- read/write a file

- sync and freeze the filesystems

- suspend the guest

- reconfigure guest local processors

- set user's password

- ...

qemu-ga will read a system configuration file on startup (located at /etc/qemu/qemu-ga.conf by default), then parse remaining configuration options on the command line. For the same key, the last option wins, but the lists accumulate (see below for configuration file format).

## OPTIONS
-m, --method=METHOD

Transport method: one of unix-listen, virtio-serial, or isa-serial, or vsock-listen (virtio-serial is the default).

-p, --path=PATH

Device/socket path (the default for virtio-serial is /dev/virtio-ports/org.qemu.guest_agent.0, the default for isa-serial is /dev/ttyS0). Socket addresses for vsock-listen are written as <cid>:<port>.

-l, --logfile=PATH

Set log file path (default is stderr).

-f, --pidfile=PATH

Specify pid file (default is /var/run/qemu-ga.pid).

-F, --fsfreeze-hook=PATH

Enable fsfreeze hook. Accepts an optional argument that specifies script to run on freeze/thaw. Script will be called with 'freeze'/'thaw' arguments accordingly (default is /etc/qemu/fsfreeze-hook). If using -F with an argument, do not follow -F with a space (for example: -F/var/run/fsfreezehook.sh).

-t, --statedir=PATH

Specify the directory to store state information (absolute paths only, default is /var/run).

-v, --verbose

Log extra debugging information.

-V, --version

Print version information and exit.

-d, --daemon

Daemonize after startup (detach from terminal).

-b, --block-rpcs=LIST

Comma-separated list of RPCs to disable (no spaces, use help to list available RPCs).

-a, --allow-rpcs=LIST

Comma-separated list of RPCs to enable (no spaces, use help to list available RPCs).

-D, --dump-conf

Dump the configuration in a format compatible with qemu-ga.conf and exit.

-h, --help

Display this help and exit.

## FILES
The syntax of the qemu-ga.conf configuration file follows the Desktop Entry Specification, here is a quick summary: it consists of groups of key-value pairs, interspersed with comments.

```
# qemu-ga configuration sample
[general]
daemonize = 0
pidfile = /var/run/qemu-ga.pid
verbose = 0
method = virtio-serial
path = /dev/virtio-ports/org.qemu.guest_agent.0
statedir = /var/run
```

The list of keys follows the command line options:

Key

Key type

daemon

boolean

method

string

path

string

logfile

string

pidfile

string

fsfreeze-hook

string

statedir

string

verbose

boolean

block-rpcs

string list

## SEE ALSO
qemu(1)

## AUTHOR
Michael Roth <mdroth@linux.vnet.ibm.com>

## COPYRIGHT
2024, The QEMU Project Developers


qemu-nbd

package: qemu-img

title: qemu-nbd(8)

summary: QEMU Disk Network Block Device Server

text:
# qemu-nbd(8)

## NAME
qemu-nbd - QEMU Disk Network Block Device Server

## SYNOPSIS
qemu-nbd [OPTION]... filename

qemu-nbd -L [OPTION]...

qemu-nbd -d dev

## DESCRIPTION
Export a QEMU disk image using the NBD protocol.

Other uses:

- Bind a /dev/nbdX block device to a QEMU server (on Linux).

- As a client to query exports of a remote NBD server.

## OPTIONS
filename is a disk image filename, or a set of block driver options if --image-opts is specified.

dev is an NBD device.

--object type,id=ID,...

Define a new instance of the type object class identified by ID. See the qemu(1) manual page for full details of the properties supported. The common object types that it makes sense to define are the secret object, which is used to supply passwords and/or encryption keys, and the tls-creds object, which is used to supply TLS credentials for the qemu-nbd server or client.

-p, --port=PORT

TCP port to listen on as a server, or connect to as a client (default 10809).

-o, --offset=OFFSET

The offset into the image.

-b, --bind=IFACE

The interface to bind to as a server, or connect to as a client (default 0.0.0.0).

-k, --socket=PATH

Use a unix socket with path PATH.

--image-opts

Treat filename as a set of image options, instead of a plain filename. If this flag is specified, the -f flag should not be used, instead the format= option should be set.

-f, --format=FMT

Force the use of the block driver for format FMT instead of auto-detecting.

-r, --read-only

Export the disk as read-only.

-A, --allocation-depth

Expose allocation depth information via the qemu:allocation-depth metadata context accessible through NBD_OPT_SET_META_CONTEXT.

-B, --bitmap=NAME

If filename has a qcow2 persistent bitmap NAME, expose that bitmap via the qemu:dirty-bitmap:NAME metadata context accessible through NBD_OPT_SET_META_CONTEXT.

-s, --snapshot

Use filename as an external snapshot, create a temporary file with backing_file=filename, redirect the write to the temporary one.

-l, --load-snapshot=SNAPSHOT_PARAM

Load an internal snapshot inside filename and export it as an read-only device, SNAPSHOT_PARAM format is snapshot.id=[ID],snapshot.name=[NAME] or [ID_OR_NAME]

--cache=CACHE

The cache mode to be used with the file. Valid values are: none, writeback (the default), writethrough, directsync and unsafe. See the documentation of the emulator's -drive cache=... option for more info.

-n, --nocache

Equivalent to --cache=none.

--aio=AIO

Set the asynchronous I/O mode between threads (the default), native (Linux only), and io_uring (Linux 5.1+).

--discard=DISCARD

Control whether discard (also known as trim or unmap) requests are ignored or passed to the filesystem. DISCARD is one of ignore (or off), unmap (or on). The default is ignore.

--detect-zeroes=DETECT_ZEROES

Control the automatic conversion of plain zero writes by the OS to driver-specific optimized zero write commands. DETECT_ZEROES is one of off, on, or unmap. unmap converts a zero write to an unmap operation and can only be used if DISCARD is set to unmap. The default is off.

-c, --connect=DEV

Connect filename to NBD device DEV (Linux only).

-d, --disconnect

Disconnect the device DEV (Linux only).

-e, --shared=NUM

Allow up to NUM clients to share the device (default 1), 0 for unlimited.

-t, --persistent

Don't exit on the last connection.

-x, --export-name=NAME

Set the NBD volume export name (default of a zero-length string).

-D, --description=DESCRIPTION

Set the NBD volume export description, as a human-readable string.

-L, --list

Connect as a client and list all details about the exports exposed by a remote NBD server. This enables list mode, and is incompatible with options that change behavior related to a specific export (such as --export-name, --offset, ...).

--tls-creds=ID

Enable mandatory TLS encryption for the server by setting the ID of the TLS credentials object previously created with the --object option; or provide the credentials needed for connecting as a client in list mode.

--tls-hostname=hostname

When validating an x509 certificate received over a TLS connection, the hostname that the NBD client used to connect will be checked against information in the server provided certificate. Sometimes it might be required to override the hostname used to perform this check. For example, if the NBD client is using a tunnel from localhost to connect to the remote server, the --tls-hostname option should be used to set the officially expected hostname of the remote NBD server. This can also be used if accessing NBD over a UNIX socket where there is no inherent hostname available. This is only permitted when acting as a NBD client with the --list option.

--fork

Fork off the server process and exit the parent once the server is running.

--pid-file=PATH

Store the server's process ID in the given file.

--tls-authz=ID

Specify the ID of a qauthz object previously created with the --object option. This will be used to authorize connecting users against their x509 distinguished name.

-v, --verbose

Display extra debugging information. This option also keeps the original STDERR stream open if the qemu-nbd process is daemonized due to other options like --fork or -c.

-h, --help

Display this help and exit.

-V, --version

Display version information and exit.

-T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]

Specify tracing options. [enable=]PATTERN

Immediately enable events matching PATTERN (either event name or a globbing pattern). This option is only available if QEMU has been compiled with the simple, log or ftrace tracing backend. To specify multiple events or patterns, specify the -trace option multiple times. Use -trace help to print a list of names of trace points.

events=FILE

Immediately enable events listed in FILE. The file must contain one event name (as listed in the trace-events-all file) per line; globbing patterns are accepted too. This option is only available if QEMU has been compiled with the simple, log or ftrace tracing backend.

file=FILE

Log output traces to FILE. This option is only available if QEMU has been compiled with the simple tracing backend.

## EXAMPLES
Start a server listening on port 10809 that exposes only the guest-visible contents of a qcow2 file, with no TLS encryption, and with the default export name (an empty string). The command is one-shot, and will block until the first successful client disconnects:

```
qemu-nbd -f qcow2 file.qcow2
```

Start a long-running server listening with encryption on port 10810, and allow clients with a specific X.509 certificate to connect to a 1 megabyte subset of a raw file, using the export name 'subset':

```
qemu-nbd \

  --object tls-creds-x509,id=tls0,endpoint=server,dir=/path/to/qemutls \

  --object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,\

            O=Example Org,,L=London,,ST=London,,C=GB' \

  --tls-creds tls0 --tls-authz auth0 \

  -t -x subset -p 10810 \

  --image-opts driver=raw,offset=1M,size=1M,file.driver=file,file.filename=file.raw
```

Serve a read-only copy of a guest image over a Unix socket with as many as 5 simultaneous readers, with a persistent process forked as a daemon:

```
qemu-nbd --fork --persistent --shared=5 --socket=/path/to/sock \

  --read-only --format=qcow2 file.qcow2
```

Expose the guest-visible contents of a qcow2 file via a block device /dev/nbd0 (and possibly creating /dev/nbd0p1 and friends for partitions found within), then disconnect the device when done. Access to bind qemu-nbd to a /dev/nbd device generally requires root privileges, and may also require the execution of modprobe nbd to enable the kernel NBD client module. CAUTION: Do not use this method to mount filesystems from an untrusted guest image - a malicious guest may have prepared the image to attempt to trigger kernel bugs in partition probing or file system mounting.

```
qemu-nbd -c /dev/nbd0 -f qcow2 file.qcow2
qemu-nbd -d /dev/nbd0
```

Query a remote server to see details about what export(s) it is serving on port 10809, and authenticating via PSK:

```
qemu-nbd \

  --object tls-creds-psk,id=tls0,dir=/tmp/keys,username=eblake,endpoint=client \

  --tls-creds tls0 -L -b remote.example.com
```

## SEE ALSO
qemu(1), qemu-img(1)

## AUTHOR
Anthony Liguori <anthony@codemonkey.ws>

## COPYRIGHT
2024, The QEMU Project Developers


qemu-pr-helper

package: qemu-pr-helper

title: qemu-pr-helper(8)

summary: QEMU persistent reservation helper

text:
# qemu-pr-helper(8)

## NAME
qemu-pr-helper - QEMU persistent reservation helper

## SYNOPSIS
qemu-pr-helper [OPTION]

## DESCRIPTION
Implements the persistent reservation helper for QEMU.

SCSI persistent reservations allow restricting access to block devices to specific initiators in a shared storage setup. When implementing clustering of virtual machines, it is a common requirement for virtual machines to send persistent reservation SCSI commands. However, the operating system restricts sending these commands to unprivileged programs because incorrect usage can disrupt regular operation of the storage fabric. QEMU's SCSI passthrough devices scsi-block and scsi-generic support passing guest persistent reservation requests to a privileged external helper program. qemu-pr-helper is that external helper; it creates a listener socket which will accept incoming connections for communication with QEMU.

If you want to run VMs in a setup like this, this helper should be started as a system service, and you should read the QEMU manual section on "persistent reservation managers" to find out how to configure QEMU to connect to the socket created by qemu-pr-helper.

After connecting to the socket, qemu-pr-helper can optionally drop root privileges, except for those capabilities that are needed for its operation.

qemu-pr-helper can also use the systemd socket activation protocol. In this case, the systemd socket unit should specify a Unix stream socket, like this:

```
[Socket]
ListenStream=/var/run/qemu-pr-helper.sock
```

## OPTIONS
-d, --daemon

run in the background (and create a PID file)

-q, --quiet

decrease verbosity

-v, --verbose

increase verbosity

-f, --pidfile=PATH

PID file when running as a daemon. By default the PID file is created in the system runtime state directory, for example /var/run/qemu-pr-helper.pid.

-k, --socket=PATH

path to the socket. By default the socket is created in the system runtime state directory, for example /var/run/qemu-pr-helper.sock.

-T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]

Specify tracing options. [enable=]PATTERN

Immediately enable events matching PATTERN (either event name or a globbing pattern). This option is only available if QEMU has been compiled with the simple, log or ftrace tracing backend. To specify multiple events or patterns, specify the -trace option multiple times. Use -trace help to print a list of names of trace points.

events=FILE

Immediately enable events listed in FILE. The file must contain one event name (as listed in the trace-events-all file) per line; globbing patterns are accepted too. This option is only available if QEMU has been compiled with the simple, log or ftrace tracing backend.

file=FILE

Log output traces to FILE. This option is only available if QEMU has been compiled with the simple tracing backend.

-u, --user=USER

user to drop privileges to

-g, --group=GROUP

group to drop privileges to

-h, --help

Display a help message and exit.

-V, --version

Display version information and exit.

## COPYRIGHT
2024, The QEMU Project Developers


qphotorec

package: qphotorec

title: qphotorec(8)

text:
# qphotorec(8)

## NAME
qphotorec - Recover lost files from harddisk, digital camera and cdrom

## SYNOPSIS
qphotorec

## DESCRIPTION

QPhotoRec is a GUI file data recovery software designed to recover lost files including video, documents and archives from Hard Disks and CDRom and lost pictures (Photo Recovery) from digital camera memory. QPhotoRec ignores the filesystem and goes after the underlying data, so it'll work even if your media's filesystem is severely damaged or formatted. PhotoRec is safe to use, it will never attempt to write to the drive or memory support you are about to recover lost data from.

For more information on how to use, please visit the wiki pages on www.cgsecurity.org

## SEE ALSO
photorec(8), testdisk(8), fdisk(8).

## AUTHOR
QPhotoRec 7.1, Data Recovery Utility, July 2019

Christophe GRENIER <grenier@cgsecurity.org>

https://www.cgsecurity.org


pxfw

package: qpxtool

title: pxfw(8)

text:
# pxfw(8)

## NAME
pxfw - Firmware flashing tool for Plextor CD/DVD devices

## SYNOPSIS
pxfw -l

pxfw -d DEVICE [-if firmware.bin] [-u] [-f] [-v]

pxfw -d DEVICE [-e] [-r] [-t] [-v]

## DESCRIPTION
pxfw is the linux firmware flasher for Plextor CD and DVD drives. Remove any disks before flashing.

## FEATURES
You can flash the firmware of these drives:

Plextor Premium, Premium-2, PX-712, PX-716, PX-755 and PX-760.

## DEVICE
can be an IDE, SCSI, SATA, USB or FireWire connected optical drive. Not all SATA controller support all Plextor features.

Linux:

/dev/hdX: IDE device

/dev/scdX: Linux 2.4: SATA, SCSI, USB device, or IDE device via ide-scsi emulation

/dev/srX: Linux 2.6: IDE device via new ATA layer, SCSI or USB device

OpenBSD/NetBSD:

/dev/rcdX

FreeBSD:

/dev/cd: SCSI device

/dev/acd: ATA device

MacOS X:

/dev/disk:

win32:

C:,D:,E:, ... X:,Y:,Z:

## OPTIONS
-l scan busses for all available CD and DVD devices

-if select inputfile. Specify the firmware binary file, which should

be written to DEVICE.

-u proceed update. When the firmware checksum test has succeeded,

write firmware to DEVICE.

-f force flashing. Even if DEVICE is not recognized, or firmware.

checksum has failed, firmware writing will be forced.

Handle with care.

-e read EEPROM from DEVICE.

-r reboot the device.

-t test which opcodes are supported by the device.

-v debug.

## EXAMPLES
pxfw -d /dev/hdc -if 755_1.07.bin -u

writes firmware file 755_1.07.bin into Master Drive on Secondary IDE-Port.

pxfw -d /dev/sr3 -e -oe file.foo

reades EEPROM from device /dev/sr3 and writes it to file.foo. please report man page improvements to T.Maguin@web.de


bgpd

package: quagga

title: bgpd(8)

summary: a BGPv4, BGPv4\+, BGPv4\- routing engine for use with Quagga routing

text:
# bgpd(8)

## NAME
bgpd - a BGPv4, BGPv4+, BGPv4- routing engine for use with Quagga routing software

## SYNOPSIS
bgpd [ -dhrSv ] [ -f config-file ] [ -i pid-file ] [ -p bgp-port-number ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
bgpd is a routing component that works with the Quagga routing engine.

## OPTIONS
Options available for the bgpd command:

-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/bgpd.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When bgpd starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart bgpd. The likely default is /var/run/bgpd.pid.

-p, --bgp_port bgp-port-number

Set the port that bgpd will listen to for bgp data.

-P, --vty_port port-number

Specify the port that the bgpd VTY will listen on. This defaults to 2605, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the bgpd VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-r, --retain

When the program terminates, retain routes added by bgpd.

-S, --skip_runas

Skip setting the process effective user and group.

-v, --version

Print the version and exit.

## FILES
/usr/sbin/bgpd

The default location of the bgpd binary.

/etc/quagga/bgpd.conf

The default location of the bgpd config file.

$(PWD)/bgpd.log

If the bgpd process is config'd to output logs to a file, then you will find this file in the directory where you started bgpd.

## WARNING
This man page is intended to be a quick reference for command line options. The definitive document is the Info file Quagga.

## DIAGNOSTICS
The bgpd process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. bgpd supports many debugging options, see the Info file, or the source for details.

## SEE ALSO
ripd(8), ripngd(8), ospfd(8), ospf6d(8), isisd(8), nhrpd(8), zebra(8), vtysh(1)

## BUGS
bgpd eats bugs for breakfast. If you have food for the maintainers try http://bugzilla.quagga.net

## AUTHORS
See http://www.zebra.org and http://www.quagga.net or the Info file for an accurate list of authors.


isisd

title: isisd(8)

text:
# isisd(8)

## NAME
isisd - an IS-IS routing engine for use with Quagga routing software.

## SYNOPSIS
isisd [ -dhv ] [ -f config-file ] [ -i pid-file ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
isisd is a routing component that works with the Quagga routing engine.

## OPTIONS
Options available for the isisd command:

-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/isisd.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When isisd starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart isisd. The likely default is /var/run/isisd.pid.

-P, --vty_port port-number

Specify the port that the isisd VTY will listen on. This defaults to 2608, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the isisd VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-v, --version

Print the version and exit.

## FILES
/usr/sbin/isisd

The default location of the isisd binary.

/etc/quagga/isisd.conf

The default location of the isisd config file.

$(PWD)/isisd.log

If the isisd process is config'd to output logs to a file, then you will find this file in the directory where you started isisd.

## WARNING
This man page is intended to be a quick reference for command line options. The definitive document is the Info file Quagga.

## DIAGNOSTICS
The isisd process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. isisd supports many debugging options, see the Info file, or the source for details.

## SEE ALSO
bgpd(8), ripd(8), ripngd(8), ospfd(8), ospf6d(8), zebra(8), vtysh(1)

## BUGS
isisd is ALPHA quality at the moment and hasn't any way ready for production use.

isisd eats bugs for breakfast. If you have food for the maintainers try http://bugzilla.quagga.net

## AUTHORS
See http://isisd.sourceforge.net or the Info file for an accurate list of authors.


nhrpd

title: nhrpd(8)

text:
# nhrpd(8)

## NAME
nhrpd - a Next Hop Routing Protocol routing engine for use with Quagga routing software.

## SYNOPSIS
nhrpd [ -dhv ] [ -f config-file ] [ -i pid-file ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
nhrpd is a routing component that works with the Quagga routing engine.

## OPTIONS
Options available for the nhrpd command:

-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/nhrpd.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When nhrpd starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart nhrpd. The likely default is /var/run/nhrpd.pid.

-P, --vty_port port-number

Specify the port that the nhrpd VTY will listen on. This defaults to 2608, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the nhrpd VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-v, --version

Print the version and exit.

## FILES
/usr/sbin/nhrpd

The default location of the nhrpd binary.

/etc/quagga/nhrpd.conf

The default location of the nhrpd config file.

$(PWD)/nhrpd.log

If the nhrpd process is config'd to output logs to a file, then you will find this file in the directory where you started nhrpd.

## WARNING
This man page is intended to be a quick reference for command line options. The definitive document is the Info file Quagga.

## DIAGNOSTICS
The nhrpd process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. nhrpd supports many debugging options, see the Info file, or the source for details.

## SEE ALSO
bgpd(8), ripd(8), ripngd(8), ospfd(8), ospf6d(8), zebra(8), vtysh(1)

nhrpd eats bugs for breakfast. If you have food for the maintainers try http://bugzilla.quagga.net

## AUTHORS
Timo Teräs <timo.teras@iki.fi>


title: ospf6d(8)

text:
# ospf6d(8)

## NAME
ospf6d - an OSPFv3 routing engine for use with Quagga routing software.

## SYNOPSIS
ospf6d [ -dhv ] [ -f config-file ] [ -i pid-file ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
ospf6d is a routing component that works with the Quagga routing engine.

## OPTIONS
Options available for the ospf6d command:

## OPTIONS
-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/ospf6d.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When ospf6d starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart ospf6d. The likely default is /var/run/ospf6d.pid.

-P, --vty_port port-number

Specify the port that the ospf6d VTY will listen on. This defaults to 2606, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the ospf6d VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-v, --version

Print the version and exit.

## FILES
/usr/sbin/ospf6d

The default location of the ospf6d binary.

/etc/quagga/ospf6d.conf

The default location of the ospf6d config file.

$(PWD)/ospf6d.log

If the ospf6d process is config'd to output logs to a file, then you will find this file in the directory where you started ospf6d.

## WARNING
This man page is intended to be a quick reference for command line options. The definitive document is the Info file Quagga.

## DIAGNOSTICS
The ospf6d process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. ospf6d supports many debugging options, see the Info file, or the source for details.

## SEE ALSO
bgpd(8), ripd(8), ripngd(8), ospfd(8), isisd(8), zebra(8), vtysh(1)

## BUGS
ospf6d eats bugs for breakfast. If you have food for the maintainers try http://bugzilla.quagga.net

## AUTHORS
See http://www.zebra.org and http://www.quagga.net or the Info file for an accurate list of authors.


ospfclient

title: ospfclient(8)

summary: an example ospf-api client

text:
# ospfclient(8)

## NAME
ospfclient - an example ospf-api client

## SYNOPSIS
ospfclient ospfd lsatype opaquetype opaqueid ifaddr areaid

## DESCRIPTION
ospfclient is a an example ospf-api client to test the ospfd daemon.

## OPTIONS
ospfd

A router where the API-enabled OSPF daemon is running.

lsatype

The value has to be either "9", "10", or "11", depending on the flooding scope.

opaquetype

The value has to be in the range of 0-255 (for example, experimental applications use opaquetype larger than 128).

opaqueid

Arbitrary application instance (24 bits).

ifaddr

Interface IP address for type 9, otherwise it will be ignored.

areaid

Area in the IP address format for type 10, otherwise it will be ignored.

## SEE ALSO
ospfd(8).

## AUTHORS
See the project homepage at <http://www.quagga.net/>.


ospfd

title: ospfd(8)

text:
# ospfd(8)

## NAME
ospfd - an OSPFv2 routing engine for use with Quagga routing software.

## SYNOPSIS
ospfd [ -dhlv ] [ -f config-file ] [ -i pid-file ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
ospfd is a routing component that works with the Quagga routing engine.

## OPTIONS
Options available for the ospfd command:

-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/ospfd.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When ospfd starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart ospfd. The likely default is /var/run/ospfd.pid.

-P, --vty_port port-number

Specify the port that the ospfd VTY will listen on. This defaults to 2604, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the ospfd VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-a, --apiserver

Enable OSPF apiserver. Default is disabled.

-v, --version

Print the version and exit.

## FILES
/usr/sbin/ospfd

The default location of the ospfd binary.

/etc/quagga/ospfd.conf

The default location of the ospfd config file.

$(PWD)/ospfd.log

If the ospfd process is config'd to output logs to a file, then you will find this file in the directory where you started ospfd.

## WARNING
This man page is intended to be a quick reference for command line options. The definitive document is the Info file Quagga.

## DIAGNOSTICS
The ospfd process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. ospfd supports many debugging options, see the Info file, or the source for details.

## SEE ALSO
bgpd(8), ripd(8), ripngd(8), ospf6d(8), isisd(8), zebra(8), vtysh(1)

## BUGS
ospfd eats bugs for breakfast. If you have food for the maintainers try http://bugzilla.quagga.net

## AUTHORS
See http://www.zebra.org and http://www.quagga.net or the Info file for an accurate list of authors.


pimd

title: pimd(8)

text:
# pimd(8)

## NAME
pimd - a PIM routing for use with Quagga Routing Suite.

## SYNOPSIS
pimd [ -dhvZ ] [ -f config-file ] [ -i pid-file ] [ -z path ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
pimd is a protocol-independent multicast component that works with the Quagga Routing Suite.

## OPTIONS
Options available for the pimd command:

-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/pimd.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When pimd starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart pimd. The likely default is /var/run/pimd.pid.

-z, --socket path

Specify the socket path for contacting the zebra daemon. The likely default is /var/run/zserv.api.

-P, --vty_port port-number

Specify the port that the pimd VTY will listen on. This defaults to 2611, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the pimd VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-v, --version

Print the version and exit.

-Z, --debug_zclient

Enable logging information for zclient debugging.

## FILES
/usr/sbin/pimd

The default location of the pimd binary.

/etc/quagga/pimd.conf

The default location of the pimd config file.

/var/run/pimd.pid

The default location of the pimd pid file.

/var/run/zserv.api

The default location of the zebra unix socket file.

$(PWD)/pimd.log

If the pimd process is config'd to output logs to a file, then you will find this file in the directory where you started pimd.

## WARNING
This man page is intended to be a quick reference for command line options.

## DIAGNOSTICS
The pimd process may log to standard output, to a VTY, to a log file, or through syslog to the system logs.

## SEE ALSO
zebra(8), vtysh(1)

## BUGS
pimd is in early development at the moment and is not ready for production use.

pimd eats bugs for breakfast. If you have food for the maintainers try https://github.com/udhos/qpimd

## AUTHORS
See https://github.com/udhos/qpimd for an accurate list of authors.


ripd

title: ripd(8)

text:
# ripd(8)

## NAME
ripd - a RIP routing engine for use with Quagga routing software.

## SYNOPSIS
ripd [ -dhrv ] [ -f config-file ] [ -i pid-file ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
ripd is a routing component that works with the Quagga routing engine.

## OPTIONS
Options available for the ripd command:

## OPTIONS
-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/ripd.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When ripd starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart ripd. The likely default is /var/run/ripd.pid.

-P, --vty_port port-number

Specify the port that the ripd VTY will listen on. This defaults to 2602, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the ripd VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-r, --retain

When the program terminates, retain routes added by ripd.

-v, --version

Print the version and exit.

## FILES
/usr/sbin/ripd

The default location of the ripd binary.

/etc/quagga/ripd.conf

The default location of the ripd config file.

$(PWD)/ripd.log

If the ripd process is config'd to output logs to a file, then you will find this file in the directory where you started ripd.

## WARNING
This man page is intended to be a quick reference for command line options. The definitive document is the Info file Quagga.

## DIAGNOSTICS
The ripd process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. ripd supports many debugging options, see the Info file, or the source for details.

## SEE ALSO
bgpd(8), ripngd(8), ospfd(8), ospf6d(8), isisd(8), zebra(8), vtysh(1)

## BUGS
ripd eats bugs for breakfast. If you have food for the maintainers try http://bugzilla.quagga.net

## AUTHORS
See http://www.zebra.org and http://www.quagga.net or the Info file for an accurate list of authors.


ripngd

title: ripngd(8)

text:
# ripngd(8)

## NAME
ripngd - a RIPNG routing engine for use with Quagga routing software.

## SYNOPSIS
ripngd [ -dhlrv ] [ -f config-file ] [ -i pid-file ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
ripngd is a routing component that works with the Quagga routing engine.

## OPTIONS
Options available for the ripngd command:

## OPTIONS
-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/ripngd.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When ripngd starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart ripngd. The likely default is /var/run/ripngd.pid.

-P, --vty_port port-number

Specify the port that the ripngd VTY will listen on. This defaults to 2603, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the ripngd VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-r, --retain

When the program terminates, retain routes added by ripd.

-v, --version

Print the version and exit.

## FILES
/usr/sbin/ripngd

The default location of the ripngd binary.

/etc/quagga/ripngd.conf

The default location of the ripngd config file.

$(PWD)/ripngd.log

If the ripngd process is config'd to output logs to a file, then you will find this file in the directory where you started ripngd.

## WARNING
This man page is intended to be a quick reference for command line options. The definitive document is the Info file Quagga.

## DIAGNOSTICS
The ripngd process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. ripngd supports many debugging options, see the Info file, or the source for details.

## SEE ALSO
bgpd(8), ripd(8), ospfd(8), ospf6d(8), isisd(8), zebra(8), vtysh(1)

## BUGS
ripngd eats bugs for breakfast. If you have food for the maintainers try http://bugzilla.quagga.net

## AUTHORS
See http://www.zebra.org and http://www.quagga.net or the Info file for an accurate list of authors.


watchquagga

title: watchquagga(8)

text:
# watchquagga(8)

## NAME
watchquagga - a program to monitor the status of quagga daemons

## SYNOPSIS
watchquagga [option...] daemon...

watchquagga -h | -v

## DESCRIPTION
watchquagga is a watchdog program that monitors the status of supplied quagga daemons and tries to restart them in case they become unresponsive or shut down.

To determine whether a daemon is running, it tries to connect to the daemon's VTY UNIX stream socket, and send echo commands to ensure the daemon responds. When the daemon crashes, EOF is received from the socket, so that watchquagga can react immediately.

This program can run in one of the following 5 modes:

Mode 0: monitor

In this mode, the program serves as a monitor and reports status changes.

Example usage: watchquagga -d zebra ospfd bgpd

Mode 1: global restart

In this mode, whenever a daemon hangs or crashes, the given command is used to restart all watched daemons.

Example usage: watchquagga -dz \

-R '/sbin/service zebra restart; /sbin/service ospfd restart' \

zebra ospfd

Mode 2: individual daemon restart

In this mode, whenever a single daemon hangs or crashes, the given command is used to restart this daemon only.

Example usage: watchquagga -dz -r '/sbin/service %s restart' \

zebra ospfd bgpd

Mode 3: phased zebra restart

In this mode, whenever a single daemon hangs or crashes, the given command is used to restart this daemon only. The only exception is the zebra daemon; in this case, the following steps are taken: (1) all other daemons are stopped, (2) zebra is restarted, and (3) other daemons are started again.

Example usage: watchquagga -adz -r '/sbin/service %s restart' \

-s '/sbin/service %s start' \

-k '/sbin/service %s stop' zebra ospfd bgpd

Mode 4: phased global restart for any failure

In this mode, whenever a single daemon hangs or crashes, the following steps are taken: (1) all other daemons are stopped, (2) zebra is restarted, and (3) other daemons are started again.

Example usage: watchquagga -Adz -r '/sbin/service %s restart' \

-s '/sbin/service %s start' \

-k '/sbin/service %s stop' zebra ospfd bgpd

Important: It is believed that mode 2 (individual daemon restart) is not safe, and mode 3 (phased zebra restart) may not be safe with certain routing daemons.

In order to avoid restarting the daemons in quick succession, you can supply the -m and -M options to set the minimum and maximum delay between the restart commands. The minimum restart delay is recalculated each time a restart is attempted. If the time since the last restart attempt exceeds twice the value of -M, the restart delay is set to the value of -m, otherwise the interval is doubled (but capped at the value of -M).

## OPTIONS
-d, --daemon

Run in daemon mode. When supplied, error messages are sent to Syslog instead of standard output (stdout).

-S directory, --statedir directory

Set the VTY socket directory (the default value is "/var/run/quagga").

-e, --no-echo

Do not ping the daemons to test whether they respond. This option is necessary if one or more daemons do not support the echo command.

-l level, --loglevel level

Set the logging level (the default value is "6"). The value should range from 0 (LOG_EMERG) to 7 (LOG_DEBUG), but higher number can be supplied if extra debugging messages are required.

-m number, --min-restart-interval number

Set the minimum number of seconds to wait between invocations of the daemon restart commands (the default value is "60").

-M number, --max-restart-interval number

Set the maximum number of seconds to wait between invocations of the daemon restart commands (the default value is "600").

-i number, --interval number

Set the status polling interval in seconds (the default value is "5").

-t number, --timeout number

Set the unresponsiveness timeout in seconds (the default value is "10").

-T number, --restart-timeout number

Set the restart (kill) timeout in seconds (the default value is "20"). If any background jobs are still running after this period has elapsed, they will be killed.

-r command, --restart command

Supply a Bourne shell command to restart a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.

Note that -r and -R options are not compatible.

-s command, --start-command command

Supply a Bourne shell command to start a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.

-k command, --kill-command command

Supply a Bourne shell command to stop a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.

-R, --restart-all

When one or more daemons are shut down, try to restart them using the Bourne shell command supplied on the command line.

Note that -r and -R options are not compatible.

-z, --unresponsive-restart

When a daemon is in an unresponsive state, treat it as being shut down for the restart purposes.

-a, --all-restart

When zebra hangs or crashes, restart all daemons taking the following steps: (1) stop all other daemons, (2) restart zebra, and (3) start other daemons again.

Note that this option also requires -r, -s, and -k options to be specified.

-A, --always-all-restart

When any daemon (i.e., not just zebra) hangs or crashes, restart all daemons taking the following steps: (1) stop all other daemons, (2) restart zebra, and (3) start other daemons again.

Note that this option also requires -r, -s, and -k options to be specified.

-p filename, --pid-file filename

Set the process identifier filename (the default value is "/var/run/quagga/watchquagga.pid").

-b string, --blank-string string

When the supplied string is found in any of the command line option arguments (i.e., -r, -s, -k, or -R), replace it with a space.

This is an ugly hack to circumvent problems with passing the command line arguments containing embedded spaces.

-v, --version

Display the version information and exit.

-h, --help

Display the usage information and exit.

## SEE ALSO
zebra(8), bgpd(8), isisd(8), ospfd(8), ospf6d(8), ripd(8), ripngd(8)

See the project homepage at <http://www.quagga.net/>.

## AUTHORS
Copyright 2004 Andrew J. Schorr


zebra

title: zebra(8)

text:
# zebra(8)

## NAME
zebra - a routing manager for use with associated Quagga components.

## SYNOPSIS
zebra [ -bdhklrv ] [ -f config-file ] [ -i pid-file ] [ -P port-number ] [ -A vty-address ] [ -u user ] [ -g group ]

## DESCRIPTION
zebra is a routing manager that implements the zebra route engine. zebra supports RIPv1, RIPv2, RIPng, OSPF, OSPF6, IS-IS, BGP4+, and BGP4-.

## OPTIONS
Options available for the zebra command:

-b, --batch

Runs in batch mode, zebra parses its config and exits.

-d, --daemon

Runs in daemon mode, forking and exiting from tty.

-f, --config-file config-file

Specifies the config file to use for startup. If not specified this option will likely default to /etc/quagga/zebra.conf.

-g, --group group

Specify the group to run as. Default is quagga.

-h, --help

A brief message.

-i, --pid_file pid-file

When zebra starts its process identifier is written to pid-file. The init system uses the recorded PID to stop or restart zebra. The likely default is /var/run/zebra.pid.

-k, --keep_kernel

On startup, don't delete self inserted routes.

-P, --vty_port port-number

Specify the port that the zebra VTY will listen on. This defaults to 2601, as specified in /etc/services.

-A, --vty_addr vty-address

Specify the address that the zebra VTY will listen on. Default is all interfaces.

-u, --user user

Specify the user to run as. Default is quagga.

-r, --retain

When the program terminates, retain routes added by zebra.

-s, --nl-bufsize netlink-buffer-size

Set netlink receive buffer size. There are cases where zebra daemon can't handle flood of netlink messages from kernel. If you ever see "recvmsg overrun" messages in zebra log, you are in trouble. Solution is to increase receive buffer of netlink socket. Note that kernel < 2.6.14 doesn't allow increasing it over the maximum value defined in /proc/sys/net/core/rmem_max. If you want to do it, you have to increase maximum before starting zebra.

Note that this affects Linux only.

-v, --version

Print the version and exit.

## FILES
/usr/sbin/zebra

The default location of the zebra binary.

/etc/quagga/zebra.conf

The default location of the zebra config file.

$(PWD)/zebra.log

If the zebra process is config'd to output logs to a file, then you will find this file in the directory where you started zebra.

## WARNING
This man page is intended to be a quick reference for command line options. The definitive document is the Info file Quagga.

## DIAGNOSTICS
The zebra process may log to standard output, to a VTY, to a log file, or through syslog to the system logs. zebra supports many debugging options, see the Info file, or the source for details.

## SEE ALSO
bgpd(8), ripd(8), ripngd(8), ospfd(8), ospf6d(8), isisd(8), nhrpd(8), vtysh(1)

## BUGS
zebra eats bugs for breakfast. If you have food for the maintainers try http://bugzilla.quagga.net

## AUTHORS
See http://www.zebra.org and http://www.quagga.net or the Info file for an accurate list of authors.


convertquota

package: quota

title: convertquota(8)

text:
# convertquota(8)

## NAME
convertquota - convert quota from old file format to new one

## SYNOPSIS
convertquota [ -ug ] -e filesystem

convertquota [ -ug ] -f oldformat,newformat filesystem

## DESCRIPTION
convertquota converts old quota files quota.user and quota.group to files aquota.user and aquota.group in new format currently used by 2.4.0-ac? and newer or by SuSE or Red Hat Linux 2.4 kernels on filesystem.

New file format allows using quotas for 32-bit uids / gids, setting quotas for root, accounting used space in bytes (and so allowing use of quotas in ReiserFS) and it is also architecture independent. This format introduces Radix Tree (a simple form of tree structure) to quota file.

## OPTIONS
-u, --user

convert user quota file. This is the default.

-g, --group

convert group quota file.

-f, --convert-format oldformat,newformat

convert quota file from oldformat to newformat.

-e, --convert-endian

convert vfsv0 file format from big endian to little endian (old kernels had a bug and did not store quota files in little endian format).

-V, --version

print version information.

## FILES
aquota.user

new user quota file

aquota.group

new group quota file

## SEE ALSO
quota(1), setquota(8), edquota(8), quotacheck(8), quotaon(8), repquota(8)

## AUTHOR
Jan Kara <jack@suse.cz>