Introduction | HP UX Identity Security Software instruction

1.4 Using Directory Server command-line scripts

In addition to command-line utilities, several non-configurable scripts are provided with the Directory Server that make it quick and easy to perform routine server administration tasks from the command-line. Chapter 7 “Command-line scripts” lists the most frequently used scripts and contains information on where the scripts are stored and how to access them.

16 Introduction

Page 16

Image 16

HP UX Identity Security Software manual Using Directory Server command-line scripts, Introduction

Contents

HP-UX Directory Server Version Page Table of Contents Table of Contents Table of Contents 3.3 3.4Nsssl3ciphers Nsslapd-state Nsslapd-backend 113 Password Storage Schemes Schema reload plug-inNsslapd-pluginEnabled Nsslapd-idl-switch Cn=userRoot, cn=ldbm database, cn=plugins, cn=config Cn=ldbm database, cn=plugins, cn=configNsMaxResponseDelay NsMaxTestResponseDelay 169 173 189 215 Finding and executing command-line scripts 215239 247 243257 Page Directory Server configuration Using Directory Server command-line utilitiesDirectory Server configuration Directory Server instance file reference Using Directory Server command-line scripts Introduction Overview of the Directory Server configuration Ldif and schema configuration files Directory Server Ldif configuration files How the server configuration is organized Configuration attributesConfiguration of plug-in functionality Directory Server Ldif configuration files Accessing and modifying server configuration Access control for configuration entriesConfiguration of databases Configuration of indexes Modifying configuration entries using Ldap Changing configuration attributesWhere Core server configuration attributes reference Configuration changes requiring server restart 1 cn=config Nsslapd-accesslog Access log Nsslapd-accesslog-level Access log level Nsslapd-accesslog-list List of access log filesNsslapd-accesslog-logbuffering Log buffering Attribute values for enabling or disabling access logging Nsslapd-accesslog-logging-enabled Access log enable logging Default Value Syntax Directory String ExampleValid Values Valid Range Disk space allowed to the access log is unlimited in size EntryDN Cn=config Valid RangeSyntaxDirectoryString Example Syntax DirectoryString Example Nsslapd-accesslog-logrotationtime Access log rotation time Nsslapd-accesslog-maxlogsize Access log maximum log size Nsslapd-accesslog-mode Access log file permission SyntaxInteger Example ValidRange Through Default Value 600 Syntax Integer Example Default Value Off Syntax DirectoryString ExampleNsslapd-attribute-name-exceptions Nsslapd-auditlog Audit log Nsslapd-auditlog-list Attribute values for enabling or disabling audit loggingProvides a list of audit log files EntryDN Nsslapd-auditlog-logging-enabled Audit log enable logging Entry DN Cn=config Valid ValuesTurns audit logging on and off Disk space allowed to the audit log is unlimited in size Valid Range Through Default Value Syntax Integer Example Nsslapd-auditlog-logrotationsynchour Syntax Integer Example Nsslapd-auditlog-logrotationsyncmin Nsslapd-auditlog-logrotationtime Audit log rotation timeTime between audit log file rotation is unlimited Nsslapd-auditlog-mode Audit log file permission Nsslapd-auditlog-maxlogsize Audit log maximum log sizeNone Read only Execute only Write access to the server user ID Nsslapd-certdir Certificate and key database directoryNsslapd-certmap-basedn Certificate map search base Write only Read and write Write and execute Nsslapd-config This read-only attribute is the config DNNsslapd-conntablesize Nsslapd-counters Nsslapd-ds4-compatible-schema Default Value Syntax DirectoryString ExampleDefault Value Off Core server configuration reference Nsslapd-csnlogging Nsslapd-errorlog-level Error log level Nsslapd-errorlog Error logAttribute values for enabling or disabling error logging Nsslapd-errorlog-list This read-only attribute provides a list of error log files Nsslapd-errorlog-logging-enabled Enable error logging Turns error logging on and off Disk space allowed to the error log is unlimited in size Nsslapd-errorlog-logrotationtime Error log rotation time Time between error log file rotation is unlimited Nsslapd-errorlog-maxlogsize Maximum error log size Nsslapd-idletimeout Default idle timeout Nsslapd-errorlog-mode Error log file permissionNsslapd-groupevalnestlevel Nsslapd-ioblocktimeout IO block time out Default Value Syntax Integer Example Nsslapd-idletimeoutNsslapd-instancedir Instance directory Nsslapd-lastmod Track modification time Nsslapd-ldapifilepath Ldapi socket file path Nsslapd-ldapilisten Enable Ldapi socketNsslapd-listenhost Listen to IP address Default Value SyntaxDirectoryString Example Nsslapd-localhost Local hostNsslapd-localuser Local user Nsslapd-lockdir Server lock file directory Nsslapd-maxbersize Maximum message size Nsslapd-maxdescriptors Maximum file descriptors Nsslapd-maxsasliosize Maximum Sasl packet size Nsslapd-nagle Nsslapd-maxthreadsperconn Maximum threads per connectionThis attribute value is specified in bytes Nsslapd-outbound-ldap-io-timeout Default Value Core server configuration referenceNsslapd-plugin Nsslapd-port Port number Nsslapd-referral Referral Nsslapd-readonly Read onlyBut the request is for this entry Nsslapd-referralmode Referral mode Nsslapd-reservedescriptors Reserved file descriptors Nsslapd-return-exact-case Return exact case Nsslapd-rewrite-rfc1274 Default Value Syntax Nsslapd-rootpw Root passwordNsslapd-rootdn Manager DN Nsslapd-rootpwstoragescheme Root password storage scheme Nsslapd-saslpath Nsslapd-schemacheck Schema checking Nsslapd-schemadir Nsslapd-securelistenhost Nsslapd-schemareplaceNsslapd-securePort Encrypted port number Nsslapd-security Security Nsslapd-sizelimit Size limit Nsslapd-threadnumber Thread number Default Value Syntax Integer Example Nsslapd-threadnumberNsslapd-timelimit Time limit PasswordChange Password change Indicates whether users may change their passwordsNsslapd-tmpdir Nsslapd-versionstring PasswordCheckSyntax Check password syntax PasswordExp Password expiration PasswordGraceLimit Password expiration PasswordHistory Password historyPasswordInHistory Number of passwords to remember Default Value Syntax Integer Example PasswordGraceLimit PasswordLockout Account lockout PasswordIsGlobalPolicy Password policy and replicationPasswordLockoutDuration Lockout duration PasswordMaxAge Password maximum age PasswordMaxFailure Maximum password failuresPasswordMaxRepeats Password syntax Default Value Syntax Integer Example PasswordMaxFailure PasswordMinAge Password minimum age PasswordMin8Bit Password syntaxDefault Value Syntax Integer Example PasswordMinAge PasswordMinAlphas Password syntax PasswordMinCategories Password syntaxPasswordMinDigits Password syntax PasswordMinLength Password minimum length PasswordMinSpecials Password syntax PasswordMinLowers Password syntaxPasswordMinTokenLength Password syntax PasswordMustChange Password must change PasswordMinUppers Password syntaxPasswordStorageScheme Password storage scheme PasswordUnlock Unlock account PasswordWarning Send warning 2 cn=changelog5,cn=config Nsslapd-changelogdir 3 cn=encryption,cn=config NssslsessiontimeoutNsslapd-changelogmaxage Max changelog age Nsslapd-changelogmaxentries Max changelog records Means disallow certificate-based authentication Default Value Off Syntax DirectoryString Example Nsssl2 offNssslclientauth NsSSL2 4 cn=features,cn=config 5 cn=mapping tree,cn=configSuffix configuration attributes under cn=suffixName Nsssl3ciphers Nsslapd-state Nsslapd-backendDetermines how the suffix handles operations To requests made by client applications NsDS5ReplicaBindDN NsDS5FlagsNsDS5ReplicaChangeCount NsDS5ReplicaPurgeDelay NsDS5ReplicaIdNsDS5ReplicaLegacyConsumer NsDS5ReplicaName NsDS5ReplicaRoot NsDS5ReplicaReferralNsDS5ReplicaTombstonePurgeInterval NsDS5ReplicaReapActive NsDS5ReplicaTypeNsState 8.1 cn NsDS5ReplConflictDescription NsDS5ReplicaBindMethod NsDS5ReplicaBusyWaitTime Schema NsDS5ReplicaChangesSentSinceStartupNsDS5ReplicaCredentials NsDS5ReplicaHost NsDS5ReplicaLastInitEnd NsDS5ReplicaLastInitStartNsDS5ReplicaLastInitStatus Time NsDS5ReplicaLastUpdateEnd NsDS5ReplicaLastUpdateStartNsDS5ReplicaLastUpdateStatus NsDS5ReplicaPort Default Value SyntaxInteger ExamplensDS5ReplicaPort389 NsDS5ReplicaPriority NsDS5BeginReplicaRefresh NsDS5ReplicaSessionPauseTime Valid Range Default Value SyntaxDirectoryString Example NsDS5ReplicaTimeoutNsDS5ReplicatedAttributeList NsDS5ReplicaUpdateSchedule NsDS5ReplicaUpdateInProgressNsDS5ReplicaTransportInfo NsDS50ruv NsDS5ReplicaLastUpdateEndSunday Nsds7NewWinGroupSyncEnabled Nsds7NewWinUserSyncEnabledNsds7DirectoryReplicaSubtree Nsds7DirsyncCookie 10 cn=monitor Nsds7WindowsDomainNsds7WindowsReplicaSubtree WinSyncInterval For example Connection tableGreenwich Mean Time This is the number of completed operations 12 cn=SNMP,cn=config NssnmpenabledThis attribute sets whether Snmp is enabled 11 cn=replication Nssnmporganization NssnmplocationNssnmpcontact Nssnmpdescription Snmp statistic attributes NssnmpmasterhostNssnmpmasterport Snmp statistic attributes 14 cn=tasks,cn=config Snmp statistic attributes Task invocation attributes for entries under cn=tasks Entry DN 14.2 cn=import,cn=tasks,cn=config Default Value Syntax DirectoryString Example Ttl NsFilename file1.ldif NsFilename file2.ldif Default Value Syntax Integer Example NsImportChunkSize 14.3 cn=export,cn=tasks,cn=config Valid Values Any DN Core server configuration reference Default Value Syntax DN, multi-valued Example Syntax Case-insensitive string Example NsUseOneFile trueSyntax Case-insensitive string Example NsExportReplica true Syntax Case-insensitive string Example NsPrintKey false 14.4 cn=backup,cn=tasks,cn=config Syntax Case-insensitive string Example NsUseId2Entry trueSyntax Case-insensitive string Example NsNoWrap false Syntax Case-insensitive string Example NsDumpUniqId true 14.5 cn=restore,cn=tasks,cn=config 14.6 cn=index,cn=tasks,cn=config Syntax Case-exact string Example 14.7 cn=schema reload task,cn=tasks,cn=config NsIndexAttribute attributeindex1,index2 14.8 cn=memberof task,cn=tasks,cn=config 15 cn=uniqueid generator,cn=config 112 1 7-bit check plug-in Server plug-in functionality referenceServer plug-in functionality reference ACL preoperation plug-in ACL plug-inAttribute uniqueness plug-in Binary syntax plug-in Boolean syntax plug-in Plug-in Name Chaining Database DN of Configuration Entry Description Syntax for handling DNs Configurable OptionsCase exact string syntax plug-in Case ignore string syntax plug-in Class of service plug-in Country string syntax plug-inDistinguished name syntax plug-in Dependencies None Performance Related Distributed numeric assignment plug-in Generalized time syntax plug-inDetails of distributed numeric assignment plug-in Plug-in Name Http client plug-in Internationalization plug-in Jpeg syntax plug-in Ldbm database plug-inLegacy replication plug-in Information Further Information Multi-master replication plug-in MemberOf plug-inDetails of MemberOf plug-in Octet string syntax plug-in Password Storage SchemesOID syntax plug-in Password storage plugins Postal address string syntax plug-in PTA plug-in Referential integrity postoperation plug-in Retro Changelog plug-in Roles plug-inBoth presence and equality Applications Details of schema reload plug-in Schema reload plug-inSpace insensitive string syntax plug-in Telephone syntax plug-in URI syntax plug-inViews plug-in Resource Locators List of attributes common to all plug-ins Account policy plug-inNsslapd-pluginPath This attribute specifies the full path to the plug-in Nsslapd-pluginEnabled Nsslapd-pluginInitfuncNsslapd-pluginType Nsslapd-pluginId Attributes allowed by certain plug-ins Nsslapd-pluginVersionNsslapd-pluginVendor Nsslapd-pluginDescription Nsslapd-plugin-depends-on-type Nsslapd-pluginLoadGlobalNsslapd-plugin-depends-on-named Database plug-in attributes NsLookthroughLimit Nsslapd-cache-autosize Nsslapd-cache-autosize-split Nsslapd-db-checkpoint-interval Nsslapd-dbcachesizePlatforms Default Value Database plug-in attributes Nsslapd-db-circular-loggingNsslapd-db-debug Nsslapd-db-durable-transactions Nsslapd-db-home-directory Nsslapd-db-idl-divisor Nsslapd-db-logbuf-size Automatically adjusted to the minimum valueNsslapd-db-logdirectory Valid Range Bytes to 64 kilobytes Default Value Nsslapd-db-logfile-sizeNsslapd-db-page-size Nsslapd-db-private-import-mem Nsslapd-db-spin-count Nsslapd-db-transaction-batch-val Nsslapd-db-verbose Nsslapd-db-trickle-percentageNsslapd-dbncache Nsslapd-directory Nsslapd-idl-switchNsslapd-exclude-from-export Nsslapd-import-cachesize Nsslapd-idlistscanlimitNsslapd-import-cache-autosize No access for other users Default Value 600 Database plug-in attributesNsslapd-mode Memory to importCache Nsslapd-search-use-vlv-index Nsslapd-search-bypass-filter-testNsslapd-serial-lock Nsslapd-cachesize Nsslapd-cachememsize Nsslapd-require-index Nsslapd-readonlyNsslapd-suffix Database plug-in attributes NsSystemIndex 5.1 cnThis attribute provides the name of the attribute to index NsIndexType NsMatchingRule NsSubStrBegin Indexed attribute representing a subentry NsSubStrEnd NsSubStrMiddle Encrypted attributes under the cn=config node Database link plug-in attributes chaining attributes NsEncryptionAlgorithmNsActiveChainingComponents Database link plug-in attributes chaining attributes NsMaxTestResponseDelay NsMaxResponseDelayNspossiblechainingcomponents NsAbandonedSearchCheckInterval NsTransmittedControlsNsBindConnectionsLimit NsBindTimeout Default Value Syntax Integer ExampleNsBindRetryLimit NsCheckLocalACI NsConcurrentBindLimit NsConcurrentOperationsLimitNsConnectionLife NsOperationConnectionsLimit NsReferralOnScopedSearch NsProxiedAuthorizationNsSizeLimit NsTimeLimit NsBindMechanism NsMultiplexorBindDN NsFarmServerURLValid Values Empty Encryption schema NsMultiplexorCredentialsNshoplimit NsUseStartTLS Retro changelog plug-in attributes Nsslapd-changelogdir Distributed numeric assignment plug-in attributes Nsslapd-changelogmaxage Max changelog ageDnaFilter DnaMagicRegen DnaNextRange DnaMaxValueDnaNextValue DnaRangeRequestTimeout Default Value Syntax Integer Example DnaNextValueDnaPrefix Bit systems DnaSharedCfgDN DnaScopeDnaThreshold MemberOf plug-in attributes DnaTypeMemberofattr Memberofgroupattr Account policy plug-in attributes Backup files Configuration filesOverview of Directory Server files Database files Setup-ds-admin.plscript is run At setup for example, dc=example,dc=comUsed internally by the database and should not be moved Deleted, or modified in any way Ldif files Lock filesLog files PID files Tools Scripts Access log reference Access logging levels Default access logging content Example 5-1 Example access logConnection number File descriptor Error number Slot numberOperation number Method type Elapsed time Number of entriesLdap request type Unindexed search indicator Ldap response typeVLV-related entries Search scope Extended operation OID Change sequence numberAbandon message LDAPv3 extended operations supported by Directory Server Message ID Access log content for additional access logging levelsSasl multi-stage bind logging Connection description Common connection codesOptions description Error log reference Error log logging levelsError log levels Common connection codes Error log content Error log levels Error log content for other log levels Example 5-3 Error log excerpt Example 5-4 Replication error log entry Into pending list Timestamp Pluginname message Timestamp function message Example 5-7 Access control summary logging Example 5-6 Config file processing log entryAudit log reference Example 5-8 Audit log content Ldap result codesAudit log does not have any other log level to set Ldap result codes Adminlimitexceeded Ldap Ldap result codesReferral Ldap Ldap Finding and executing command-line utilities Using special charactersCommand-line utilities quick reference Commonly-used command-line utilities Ldapsearch Ldapsearch syntaxCommonly-used ldapsearch options Ldapsearch syntax Commonly-used ldapsearch options Persistent search options Ldapsearch SSL optionsCommonly-used ldapsearch options Persistent search options Ldapsearch Sasl options Additional SSL ldapsearch options Sasl options Description of CRAM-MD5 mechanism options Do not permit mechanisms that allow anonymous access Description of CRAM-MD5 mechanism optionsDo not permit mechanisms susceptible to active attacks Require forward secrecy Maxbufsize Required Mech=DIGEST-MD5 Gives the Sasl Mechanism Description of DIGEST-MD5 Sasl mechanism optionsFollowing UID. For example Description of Gssapi Sasl mechanism options Additional ldapsearch options10 Additional ldapsearch options 10 Additional ldapsearch options Ldapmodify Ldapmodify syntaxCommonly-used ldapmodify options 11 Commonly-used ldapmodify options 11 Commonly-used ldapmodify options Ldapmodify SSL options12 ldapmodify SSL options 12 ldapmodify SSL options Ldapmodify Sasl options13 Sasl options Additional ldapmodify options Ldapdelete14 Additional ldapmodify options Ldapdelete syntax Commonly-used ldapdelete optionsLdapdelete SSL options 15 Commonly-used ldapdelete options 16 ldapdelete SSL options Ldapdelete Sasl options17 Sasl options Ldappasswd Additional ldapdelete optionsLdappasswd syntax 18 Additional ldapdelete options Ldappasswd-specific options General ldappasswd options19 ldappasswd-specific options 20 General ldappasswd options Ldappasswd Sasl options 20 General ldappasswd options 21 Sasl options Ldappasswd examplesSix values Example 6-2 Directory Manager generating a users password Example 6-3 User changing his own passwordLdif Ldif Ldif command has the following format DbscanLdif syntax Ldif options Dbscan options Dbscan examples23 Common options 24 Entry file options Example 6-8 Displaying VLV index file contents Example 6-13 Displaying the changelog file contentsExample 6-14 Dumping the index file uid.db4 with raw mode Example 6-7 Dumping the entry file Finding and executing command-line scripts Command-line scripts quick referenceSaveconfig Shell scripts in /opt/dirsrv/slapd-instancename Shell scripts Perl scripts in /opt/dirsrv/slapd-instancenameScripts in /opt/dirsrv/bin This section covers the following scripts 1 bak2db Restores a database from backup Cl-dump Dumps and decodes the changelogSyntax Bak2db options Dbverify Checks for corrupt databases Cl-dump optionsOptions Dbverify options 4 db2bak Creates a backup of a database 5 db2ldif Exports database contents to Ldif 6 db2index Reindexes database index files Ldif2db ImportReindex cn and givenname in the database instance userRoot Db2index options Pwdhash Prints encrypted passwords Ldif2ldap Performs import operation over LdapLdif2db options 10 ldif2ldap options Monitor Retrieves monitoring information Repl-monitor Monitors replication status11 pwdhash options Syntax monitor Hostportbinddnbindpwdbindcert Saveconfig Saves Administration Server configuration Restoreconfig Restores Administration Server configurationRestart-slapd Restarts the Directory Server Start-slapd Starts the Directory Server Stop-slapd Stops the Directory ServerSuffix2instance Maps a suffix to a backend name Vlvindex Creates virtual list view indexes 1 bak2db.pl Restores a database from backup Restores a database from a backupPerl scripts Options Either the -nor the -soption must be specified 3 db2bak.pl Creates a backup of a database 19 cl-dump.pl command optionsCreates a backup of the database Cl-dump.pl Dumps and decodes the changelog 5 db2ldif.pl Exports database contents to Ldif 4 db2index.pl Creates and generates indexes Fixup-memberof.pl Regenerate memberOf attributes 22 db2ldif.pl options 23 fixup-memberof.pl options Ldif2db.pl Import24 ldif2db.pl options Logconv.pl Log converter 25 Information extracted from access logs24 ldif2db.pl options 26 logconv.pl options 27 logconv.pl options to display occurrences Ns-accountstatus.pl Establishes account status28 ns-accountstatus.pl options Ns-activate.pl Activates an entry or group of entries Ns-inactivate.pl Inactivates an entry or group of entriesActivates an entry or group of entries 29 ns-activate.pl options Repl-monitor.pl Monitors replication status 31 ns-newpwdpolicy.pl optionsShows in-progress status of replication 32 repl-monitor.pl options Where Schema-reload.pl Reload schema files dynamically 33 schema-reload.pl optionsSchemadirectory script uses the default schema directory Verify-db.pl Check for corrupt databases 34 verify-db.pl option Command, then it uses the default database directoryUsage information How to contact HP technical support Contacting HPInformation to collect before contacting HP HP authorized resellers HP-UX Directory Server documentation set Related informationSupport and other resources Troubleshooting resources Typographic conventionsHP-UX documentation set This document uses the following typographical conventions TIP Finding and executing the ns-slapd command-line utilities Exports the contents of the database to LdifOverview of ns-slapd Utilities for exporting databases db2ldif Utilities for restoring and backing up databases ldif2db Table A-1 db2ldif optionsImports Ldif files to the database Table A-2 ldif2db options Utilities for restoring and backing up databases db2archive Utilities for restoring and backing up databases archive2dbUtilities for creating and regenerating indexes db2index Table A-5 db2index options Glossary 247 Bind rule Glossary CoS definition 249 GSS-API Ldap 251 NIS Proxy 253 Sasl Superuser 255 256 Statistics for monitoring and optimizing directory Symbols257 Suffix and replication configuration entries Read-only monitoring configuration entries 259 Index Database link plug-in configuration attributes 261 Distributed numeric assignment plug-in configuration Ldap 263 NsDS5ReplicaChangesSentSinceStartup attribute 265 Page 267 Index 269 Index 271