ConfD User Guide 6.6

confd_user_guide-6.6

User Manual:

Open the PDF directly: View PDF .
Page Count: 1026 [warning: Documents this large are best viewed by clicking the View PDF Link!]

Scroll down to view the document on your mobile browser.

ConfD User Guide
Table of Contents
Chapter 1. About the Documentation
- 1.1. How to Read This Guide
- 1.2. Getting Documentation
- 1.3. Formatting Conventions
- 1.4. Documentation Feedback
Chapter 2. An introduction to ConfD
- 2.1. An on-device software system for configuration management
- 2.2. ConfD Architecture
Chapter 3. The YANG Data Modeling Language
- 3.1. The YANG Data Modeling Language
- 3.2. YANG in ConfD
- 3.3. YANG Introduction
- 3.4. Working With YANG Modules
- 3.5. Integrity Constraints
- 3.6. The when statement
- 3.7. Using the Tail-f Extensions with YANG
  - 3.7.1. Using a YANG annotation file
- 3.8. Custom Help Texts and Error Messages
- 3.9. Hidden Data
- 3.10. An Example: Modeling a List of Interfaces
- 3.11. More on leafrefs
- 3.12. Using Multiple Namespaces
- 3.13. Module Names, Namespaces and Revisions
- 3.14. Hash Values and the id-value Statement
- 3.15. Migrating from Confspecs to YANG
- 3.16. The pyang tool
Chapter 4. Rendering Agents
- 4.1. Introduction
- 4.2. Data Model
- 4.3. Using the CLIs
- 4.4. Using NETCONF
  - 4.4.1. Generating Java classes for JNC
Chapter 5. CDB - The ConfD XML Database
- 5.1. Introduction
- 5.2. CDB
- 5.3. An example
- 5.4. Using keypaths
- 5.5. A session
- 5.6. CDB subscriptions
- 5.7. Reconnect
- 5.8. Loading initial data into CDB
- 5.9. Automatic schema upgrades and downgrades
- 5.10. Using initialization files for upgrade
- 5.11. Using MAAPI to modify CDB during upgrade
- 5.12. More complex schema upgrades
- 5.13. The full dhcpd example
Chapter 6. Operational Data
- 6.1. Introduction to Operational Data
- 6.2. Reading Statistics Data
- 6.3. Callpoints and Callbacks
- 6.4. Data Callbacks
- 6.5. User Sessions and ConfD Transactions
- 6.6. C Example with Operational Data
- 6.7. The Protocol and a Library Threads Discussion
- 6.8. Operational data in CDB
- 6.9. Delayed Replies
- 6.10. Caching Operational Data
- 6.11. Operational data lists without keys
Chapter 7. The external database API
- 7.1. Introduction to external data
- 7.2. Scenario - The database is a file
- 7.3. Callpoints and callbacks
- 7.4. Data Callbacks
- 7.5. User sessions and ConfD Transactions
- 7.6. External configuration data
- 7.7. External configuration data with transactions
- 7.8. Writable operational data
- 7.9. Supporting candidate commit
- 7.10. Discussion - CDB versus external DB
Chapter 8. Configuration Meta-Data
- 8.1. Introduction to Configuration Meta-Data
- 8.2. Meta-Data: annotation
- 8.3. Meta-Data: tag
- 8.4. Meta-Data: inactive
Chapter 9. Semantic validation
- 9.1. Why Do We Need to Validate
- 9.2. Syntactic Validation in YANG models
- 9.3. Integrity Constraints in YANG Models
- 9.4. The YANG must Statement
- 9.5. Validation Logic
- 9.6. Validation Points
- 9.7. Validating Data in C
- 9.8. Validation Points and CDB
- 9.9. Dependencies - Why Does Validation Points Get Called
- 9.10. Configuration Policies
  - 9.10.1. Example
Chapter 10. Transformations, Hooks, Hidden Data and Symlinks
- 10.1. Introduction
- 10.2. Transformation Control Flow
- 10.3. An Example
- 10.4. AAA Transform
- 10.5. Other Use Cases for Transformations
- 10.6. Hooks
  - 10.6.1. Set Hooks and Candidate Configuration
- 10.7. Hidden Data
- 10.8. tailf:symlink
  - 10.8.1. Discussion
    - Northbound Client Applications
    - Errors
Chapter 11. Actions
- 11.1. Introduction
- 11.2. Action as a Callback
  - 11.2.1. Example
  - 11.2.2. Using Threads
- 11.3. Action as an Executable
  - 11.3.1. Example
- 11.4. Related functionality
Chapter 12. Notifications
- 12.1. ConfD Asynchronous Events
- 12.2. Audit Messages
- 12.3. Syslog Messages
- 12.4. Commit Events
- 12.5. Commit Failure Events
- 12.6. Confirmed Commit Events
- 12.7. Commit Progress Events
- 12.8. User Sessions
- 12.9. High Availability - Cluster Events
- 12.10. Subagent Events
- 12.11. SNMP Agent Audit Log
- 12.12. Forwarding Events
- 12.13. In-service Upgrade Events
- 12.14. Heartbeat and Health Check Events
- 12.15. Notification stream Events
Chapter 13. In-service Data Model Upgrade
- 13.1. Introduction
- 13.2. Preparing for the Upgrade
- 13.3. Initializing the Upgrade
- 13.4. Performing the Upgrade
- 13.5. Committing the Upgrade
- 13.6. Aborting the Upgrade
- 13.7. Upgrade and HA
Chapter 14. The AAA infrastructure
- 14.1. The problem
- 14.2. Structure - data models
  - 14.2.1. Data model contents
- 14.3. AAA related items in confd.conf
- 14.4. Authentication
- 14.5. Group Membership
- 14.6. Authorization
- 14.7. The AAA cache
- 14.8. Populating AAA using CDB
- 14.9. Populating AAA using external data
- 14.10. Hiding the AAA tree
Chapter 15. The NETCONF Server
- 15.1. Introduction
- 15.2. Capabilities
  - 15.2.1. Advertising Capabilities and YANG Modules
- 15.3. NETCONF Transport Protocols
  - 15.3.1. Using OpenSSH
  - 15.3.2. Internal TCP Transport
- 15.4. Configuration of the NETCONF Server
  - 15.4.1. Error Handling
- 15.5. Extending the NETCONF Server
- 15.6. Monitoring of the NETCONF Server
- 15.7. Notification Capability
- 15.8. Using netconf-console
- 15.9. Actions Capability
- 15.10. Transactions Capability
- 15.11. Proxy Forwarding Capability
- 15.12. Inactive Capability
- 15.13. Tail-f Identification Capability
- 15.14. The Query API
- 15.15. Meta-data in Attributes
- 15.16. Namespace for Additional Error Information
Chapter 16. The CLI agent
- 16.1. Overview
- 16.2. The J-style CLI
  - 16.2.1. Command Hierarchy
  - 16.2.2. Two CLI modes
  - 16.2.3. Operational mode
  - 16.2.4. Configure mode
- 16.3. The C- and I-style CLI
  - 16.3.1. Operational/EXEC mode
  - 16.3.2. Configure mode
- 16.4. The CLI in action
  - 16.4.1. Starting the CLI
  - 16.4.2. Starting the CLI in an overloaded system
- 16.5. Environment for OS command execution
- 16.6. Command output processing
  - 16.6.1. Sort the the Output
  - 16.6.2. Count the Number of Lines in the Output
  - 16.6.3. Search for a String in the Output
  - 16.6.4. Saving the Output to a File
  - 16.6.5. Regular expressions
  - 16.6.6. Display line numbers
  - 16.6.7. Display as format
- 16.7. Range expressions
- 16.8. Autorendering of enabled/disabled
- 16.9. Actions
- 16.10. Command history
- 16.11. Clearing history
- 16.12. Command line editing
  - 16.12.1. Moving the cursor:
  - 16.12.2. Delete characters:
  - 16.12.3. Insert recently deleted text:
  - 16.12.4. Display previous command lines:
  - 16.12.5. Capitalization:
  - 16.12.6. Special:
- 16.13. Using CLI completion
  - 16.13.1. Customizing CLI completion
- 16.14. Using the comment characters # or !
- 16.15. Annotations and tags
- 16.16. Activate and Deactivate
- 16.17. CLI messages
- 16.18. confd.conf settings
- 16.19. CLI Environment
- 16.20. Commands in J-style
  - 16.20.1. Operational mode commands
  - 16.20.2. Configure mode commands
- 16.21. Commands in C/I-style
  - 16.21.1. Operational mode commands
  - 16.21.2. Configure mode commands
- 16.22. Customizing the CLI
  - 16.22.1. Modifying builtin commands
  - 16.22.2. Adding new commands
  - 16.22.3. Suppressing automatically generated modes
  - 16.22.4. Creating new configuration modes
  - 16.22.5. Custom mode names
  - 16.22.6. Adding custom show output
  - 16.22.7. Command parameters
  - 16.22.8. Hiding parts of the configuration
  - 16.22.9. EXEC commands
  - 16.22.10. File access
  - 16.22.11. Help texts
- 16.23. User defined wizards
- 16.24. User defined wizards in C
- 16.25. User defined commands in C using the C-API
- 16.26. User defined commands as shell scripts
- 16.27. Modifying built-in commands
  - 16.27.1. Renaming a command
  - 16.27.2. Hiding the old, creating new
- 16.28. Tailoring show commands
  - 16.28.1. How config="false" data is rendered
  - 16.28.2. Show templates
- 16.29. Change password at initial login
Chapter 17. The SNMP Agent
- 17.1. Introduction to the ConfD SNMP Agent
  - 17.1.1. Implementing MIBs
- 17.2. Agent Functional Description
- 17.3. Generating MIBs from YANG
- 17.4. Configuring the SNMP Agent
- 17.5. How the SNMP Agent Interacts with ConfD
- 17.6. Running the SNMP Agent as a NET-SNMP subagent
Chapter 18. Web UI Development
- 18.1. Introduction
- 18.2. Example of a common flow
- 18.3. Example of a JSON-RPC client
- 18.4. Example of a Comet client
Chapter 19. The JSON-RPC API
- 19.1. JSON-RPC
  - 19.1.1. Protocol overview
  - 19.1.2. Common concepts
    - Common errors
    - Application defined errors
  - 19.1.3. FAQ
- 19.2. Methods - commands
  - 19.2.1. Method get_cmds
    - Params
    - Result
  - 19.2.2. Method init_cmd
    - Params
    - Result
  - 19.2.3. Method send_cmd_data
  - 19.2.4. Method start_cmd
    - Params
    - Result
  - 19.2.5. Method suspend_cmd
    - Params
    - Result
  - 19.2.6. Method resume_cmd
    - Params
    - Result
  - 19.2.7. Method stop_cmd
    - Params
    - Result
- 19.3. Methods - commands - subscribe
  - 19.3.1. Method get_subscriptions
    - Params
    - Result
  - 19.3.2. Method subscribe_cdboper
  - 19.3.3. Method subscribe_changes
    - Params
    - Result
  - 19.3.4. Method subscribe_poll_leaf
    - Params
    - Result
  - 19.3.5. Method subscribe_upgrade
    - Params
    - Result
  - 19.3.6. Method subscribe_jsonrpc_batch
    - Params
    - Result
  - 19.3.7. Method start_subscription
    - Params
    - Result
  - 19.3.8. Method unsubscribe
    - Params
    - Result
- 19.4. Methods - data
  - 19.4.1. Method create
  - 19.4.2. Method delete
  - 19.4.3. Method exists
    - Params
    - Result
  - 19.4.4. Method get_case
    - Params
    - Result
  - 19.4.5. Method show_config
    - Params
    - Result
  - 19.4.6. Method load
- 19.5. Methods - data - attrs
  - 19.5.1. Method get_attrs
    - Params
    - Result
  - 19.5.2. Method set_attrs
    - Params
    - Result
- 19.6. Methods - data - leafs
  - 19.6.1. Method get_value
  - 19.6.2. Method get_values
    - Params
    - Result
  - 19.6.3. Method set_value
- 19.7. Methods - data - leafref
  - 19.7.1. Method deref
    - Params
    - Result
  - 19.7.2. Method get_leafref_values
    - Params
    - Result
- 19.8. Methods - data - lists
  - 19.8.1. Method rename_list_entry
  - 19.8.2. Method copy_list_entry
  - 19.8.3. Method move_list_entry
  - 19.8.4. Method append_list_entry
    - Params
    - Result
  - 19.8.5. Method count_list_keys
    - Params
    - Result
  - 19.8.6. Method get_list_keys
    - Params
    - Result
- 19.9. Methods - data - query
  - 19.9.1. Method query
  - 19.9.2. Method start_query
  - 19.9.3. Method run_query
  - 19.9.4. Method reset_query
  - 19.9.5. Method stop_query
- 19.10. Methods - database
  - 19.10.1. Method reset_candidate_db
    - Result
  - 19.10.2. Method lock_db
  - 19.10.3. Method unlock_db
    - Params
    - Result
  - 19.10.4. Method copy_running_to_startup_db
    - Result
- 19.11. Methods - general
  - 19.11.1. Method comet
  - 19.11.2. Method get_system_setting
    - Params
    - Result
  - 19.11.3. Method abort
    - Params
    - Result
  - 19.11.4. Method eval_XPath
    - Params
    - Result
- 19.12. Methods - messages
  - 19.12.1. Method send_message
    - Params
    - Result
  - 19.12.2. Method subscribe_messages
    - Params
    - Result
- 19.13. Methods - rollbacks
  - 19.13.1. Method get_rollbacks
    - Result
  - 19.13.2. Method get_rollback
    - Params
    - Result
  - 19.13.3. Method install_rollback
    - Params
    - Result
  - 19.13.4. Method load_rollback
    - Params
    - Result
- 19.14. Methods - schema
  - 19.14.1. Method get_schema
  - 19.14.2. Method hide_schema
    - Params
    - Result
  - 19.14.3. Method unhide_schema
    - Params
    - Result
  - 19.14.4. Method get_module_prefix_map
  - 19.14.5. Method run_action
- 19.15. Methods - session
  - 19.15.1. Method login
  - 19.15.2. Method logout
  - 19.15.3. Method kick_user
    - Params
    - Result
- 19.16. Methods - session data
  - 19.16.1. Method get_session_data
    - Params
    - Result
  - 19.16.2. Method put_session_data
    - Params
    - Result
  - 19.16.3. Method erase_session_data
    - Params
    - Result
- 19.17. Methods - transaction
  - 19.17.1. Method get_trans
  - 19.17.2. Method new_trans
  - 19.17.3. Method delete_trans
    - Params
    - Result
  - 19.17.4. Method set_trans_comment
    - Params
    - Result
  - 19.17.5. Method set_trans_label
    - Params
    - Result
- 19.18. Methods - transaction - changes
  - 19.18.1. Method is_trans_modified
    - Params
    - Result
  - 19.18.2. Method get_trans_changes
  - 19.18.3. Method validate_trans
  - 19.18.4. Method get_trans_conflicts
    - Params
    - Result
  - 19.18.5. Method resolve_trans
    - Params
    - Result
- 19.19. Methods - transaction - commit changes
  - 19.19.1. Method validate_commit
  - 19.19.2. Method clear_validate_lock
    - Params
    - Result
  - 19.19.3. Method commit
  - 19.19.4. Method abort_commit
    - Result
  - 19.19.5. Method confirm_commit
    - Result
- 19.20. Methods - transaction - webui
  - 19.20.1. Method get_webui_trans
    - Result
  - 19.20.2. Method new_webui_trans
    - Params
    - Result
Chapter 20. The web server
- 20.1. Introduction
- 20.2. Web server capabilities
- 20.3. CGI support
Chapter 21. The REST API
- 21.1. Introduction
- 21.2. Getting started
- 21.3. Resource Examples
- 21.4. Resources
- 21.5. Configuration Meta-Data
- 21.6. Request/Response headers
  - 21.6.1. Response headers
  - 21.6.2. Request headers
- 21.7. Special characters
  - 21.7.1. XML representation of special characters
  - 21.7.2. JSON representation of special characters
- 21.8. Error Responses
  - 21.8.1. User extended error messages
- 21.9. The Query API
- 21.10. Custom Response HTTP Headers
- 21.11. HTTP Status Codes
Chapter 22. The RESTCONF API
- 22.1. Introduction
- 22.2. Getting started
- 22.3. Capabilities
- 22.4. Streams
- 22.5. Schema resource
- 22.6. YANG Patch Media Type
- 22.7. Extensions
  - 22.7.1. Collections
  - 22.7.2. The RESTCONF Query API
- 22.8. Custom Response HTTP Headers
Chapter 23. The Management Agent API
- 23.1. What is MAAPI?
- 23.2. A custom toy CLI
Chapter 24. High Availability
- 24.1. Introduction to ConfD High Availability
- 24.2. HA framework requirements
- 24.3. Mode of operation
- 24.4. Security aspects
- 24.5. API
- 24.6. Ticks
- 24.7. Joining a cluster
- 24.8. Relay slaves
- 24.9. CDB replication
Chapter 25. The SNMP Gateway
- 25.1. Introduction to the ConfD SNMP Gateway
- 25.2. Configuring Agent Access
- 25.3. Compiling the MIBs
- 25.4. Receiving and Forwarding Notifications
- 25.5. Example Scenario
Chapter 26. Subagents and Proxies
- 26.1. Introduction
- 26.2. Subagent Registration
  - 26.2.1. Example
- 26.3. Subagent Requirements
- 26.4. Proxies
Chapter 27. Plug-and-play scripting
- 27.1. Introduction
- 27.2. Script storage
- 27.3. Script interface
- 27.4. Loading of scripts
- 27.5. Command scripts
- 27.6. Policy scripts
- 27.7. Post-commit scripts
  - 27.7.1. Post-commit section
  - 27.7.2. Full post-commit example
Chapter 28. Advanced Topics
- 28.1. Datastores
- 28.2. Locks
- 28.3. Installing ConfD on a target system
- 28.4. Configuring ConfD
  - 28.4.1. Using the configuration file
  - 28.4.2. Storing ConfD configuration parameters in CDB
- 28.5. Starting ConfD
- 28.6. ConfD IPC
  - 28.6.1. Using a different IPC mechanism
  - 28.6.2. Restricting access to the IPC port
- 28.7. Restart strategies
- 28.8. Security issues
- 28.9. Running ConfD as a non privileged user
- 28.10. Storing encrypted values in ConfD
- 28.11. Disaster management
- 28.12. Troubleshooting
- 28.13. Tuning the size of confd_hkeypath_t
- 28.14. Error Message Customization
- 28.15. Using a different version of OpenSSL
- 28.16. Using shared memory for schema information
- 28.17. Running application code inside ConfD
ConfD man-pages, Volume 1
- confd
- confd_aaa_bridge
- confd_cli
- confd_cmd
- confd_load
- confdc
- maapi
ConfD man-pages, Volume 3
- confd_lib
- confd_lib_cdb
- confd_lib_dp
- confd_lib_events
- confd_lib_ha
- confd_lib_lib
- confd_lib_maapi
- confd_types
ConfD man-pages, Volume 5
- clispec
- confd.conf
- mib_annotations
- tailf_yang_cli_extensions
- tailf_yang_extensions
Glossary

ConfD User Guide 6.6

confd_user_guide-6.6

Navigation menu

Versions of this User Manual:

Views

Navigation