Version information
This version is compatible with:
- Puppet Enterprise 2015.3.x
- Puppet 4.x
Start using this module
Add this module to your Puppetfile:
mod 'ciscoeng-ciscoyang', '1.0.2'
Learn more about managing modules with a PuppetfileDocumentation
ciscoyang
Table of Contents
- Overview
- Module Description
- Setup
- Usage
- The
cisco_yang
Puppet Type - The
cisco_yang_netconf
Puppet Type - Limitations
- Learning Resources
Overview
The ciscoyang
module allows configuration of IOS-XR through Cisco supported YANG data models in JSON/XML format. This module bundles the cisco_yang
and cisco_yang_netconf
Puppet types, providers, Beaker tests, and sample manifests to enable users to configure and manage IOS-XR.
Please refer to the Limitations section for details on currently supported hardware and software. The Limitations section also provides details on compatible Puppet Agent and Puppet Master versions.
This GitHub repository contains the latest version of the ciscoyang
module source code. Supported versions of the ciscoyang
module are available at Puppet Forge. Please refer to SUPPORT.md for additional details.
Contributions to this Puppet Module are welcome. Guidelines on contributions to the module are captured in CONTRIBUTING.md
Module Description
This module enables management of supported Cisco Network Elements through the cisco_yang
and cisco_yang_netconf
Puppet types and providers.
A typical role-based architecture scenario might involve a network administrator who uses a version control system to manage various YANG-based configuration files. An IT administrator who is responsible for the puppet infrastructure can simply reference the YANG files from a puppet manifest in order to deploy the configuration.
Setup
Puppet Master
Puppet Server must be installed on the Puppet Master workstation. Please see Install: Puppet Server for detailed install steps.
Next, the ciscoyang
module must be installed on the Puppet Master workstation. Please see Puppet Labs: Installing Modules for general information on Puppet module installation.
To manually install the ciscoyang
module from the github source, perform the following commands on the Puppet Master workstation:
$ git clone https://github.com/cisco/cisco-yang-puppet-module.git
$ cd cisco-yang-puppet-module
$ puppet module build
$ sudo puppet module install pkg/cisco-ciscoyang-1.0.0.tar.gz
Puppet Agent
The Puppet Agent requires installation and setup on each device. For more information please see the README-agent-install.md document for detailed instructions on agent installation and configuration on Cisco IOS-XR devices.
Usage
The following example manifest shows how to use ciscoyang
to configure two VRF instances on a Cisco IOS-XR device.
node 'default' {
cisco_yang { 'my-config':
ensure => present,
target => '{"Cisco-IOS-XR-infra-rsi-cfg:vrfs": [null]}',
source => '{"Cisco-IOS-XR-infra-rsi-cfg:vrfs": {
"vrf":[
{
"vrf-name":"VOIP",
"description":"Voice over IP",
"vpn-id":{
"vpn-oui":875,
"vpn-index":3
},
"create":[
null
]
},
{
"vrf-name":"INTERNET",
"description":"Generic external traffic",
"vpn-id":{
"vpn-oui":875,
"vpn-index":22
},
"create":[
null
]
}
]
}
}',
}
}
The following example manifest shows how to copy a file from the Puppet master to the agent and then reference it from the manifest.
file { '/root/bgp.json': source => 'puppet:///modules/ciscoyang/models/bgp.json' }
cisco_yang { '{"Cisco-IOS-XR-ipv4-bgp-cfg:bgp": [null]}':
ensure => present,
mode => replace,
source => '/root/bgp.json',
}
}
The following example manifest shows how to use ciscoyang
to configure two VRF instances on a Cisco IOS-XR device using the Yang NETCONF type.
node 'default' {
cisco_yang_netconf { 'my-config':
target => '<vrfs xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-infra-rsi-cfg"/>',
source => '<vrfs xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-infra-rsi-cfg">
<vrf>
<vrf-name>VOIP</vrf-name>
<create/>
<description>Voice over IP</description>
<vpn-id>
<vpn-oui>875</vpn-oui>
<vpn-index>3</vpn-index>
</vpn-id>
</vrf>
<vrf>
<vrf-name>INTERNET</vrf-name>
<create/>
<description>Generic external traffic</description>
<vpn-id>
<vpn-oui>875</vpn-oui>
<vpn-index>22</vpn-index>
</vpn-id>
</vrf>
</vrfs>',
mode => replace,
force => false,
}
}
--
The cisco_yang
Puppet Type
Allows IOS-XR to be configured using YANG models in JSON format via gRPC.
Parameters
target
The model path of the target node in YANG JSON format, or a reference to a local file containing the model path. For example, to configure the list of vrfs in IOS-XR, you could specify a target
of '{"Cisco-IOS-XR-infra-rsi-cfg:vrfs": [null]}' or reference a file which contained the same JSON string.
mode
Determines which mode is used when setting configuration via ensure=>present. Valid values are replace
and merge
(which is the default). If replace
is specified, the current configuration will be replaced by the configuration in the source property (corresponding to the ReplaceConfig gRPC operation). If merge
is specified, the configuration in the source property will be merged into the current configuration (corresponding to the MergeConfig gRPC operation).
force
Valid values are true
and false
(which is the default). If true
is specified, then the config in the source property is set on the device regardless of the current value. If false
is specified (or no value is specified), the default behavior is to set the configuration only if it is different from the running configuration.
Properties
ensure
Determines whether a certain configuration should be present or not on the device. Valid values are present
and absent
.
source
The model data in YANG JSON format, or a reference to a local file containing the model data. This property is only used when ensure=>present is specified. In addition, if source
is not specified when ensure=>present is used, source
will default to the value of the target
parameter. This removes some amount of redundancy when the source
and target
values are the same (or very similar).
--
The cisco_yang_netconf
Puppet Type
Allows IOS-XR to be configured using YANG models in XML format via NETCONF.
Parameters
target
The Yang Netconf XML formatted string or file location containing the filter used to query the existing configuration. For example, to configure the list of vrfs in IOS-XR, you could specify a target
of '' or reference a file which contained the equivalent Netconf XML string.
mode
Determines which mode is used when setting configuration. Valid values are replace
and merge
(which is the default). If replace
is specified, the current configuration will be replaced by the configuration in the source property. If merge
is specified, the configuration in the source property will be merged into the current configuration.
force
Valid values are true
and false
(which is the default). If true
is specified, then the config in the source property is set on the device regardless of the current value. If false
is specified (or no value is specified), the default behavior is to set the configuration only if it is different from the running configuration.
Properties
source
The model data in YANG XML Netconf format, or a reference to a local file containing the model data. *The Netconf protocol does not allow deletion of configuration subtrees, but instead requires addition of 'operation="delete"' attributes in the YANG XML specifed in the source
property.
Limitations
Minimum Requirements:
- Open source Puppet version 4.3.2+ or Puppet Enterprise 2015.3.2+
- Cisco XRv 9000, IOS XRv, NCS5K, NCS5500, OS Version 6.1.2+, 6.2.x
Learning Resources
- Puppet
- [https://learn.puppetlabs.com/](https://learn.puppetlabs.com/)
- [https://en.wikipedia.org/wiki/Puppet(software)](https://en.wikipedia.org/wiki/Puppet(software))
- Markdown (for editing documentation)
- [https://help.github.com/articles/markdown-basics/](https://help.github.com/articles/markdown-basics/)
- Ruby
- [https://en.wikipedia.org/wiki/Ruby(programming_language)](https://en.wikipedia.org/wiki/Ruby(programming_language))
- [https://www.codecademy.com/tracks/ruby](https://www.codecademy.com/tracks/ruby)
- [https://rubymonk.com/](https://rubymonk.com/)
- [https://www.codeschool.com/paths/ruby](https://www.codeschool.com/paths/ruby)
License
Copyright (c) 2016 Cisco and/or its affiliates.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Types in this module release
Change Log
All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
1.0.2 - 2017-01-19
Changed
- Tweaked Puppet requirements in metadata.json
1.0.1 - 2017-01-18
Changed
- Added Puppet requirements to metadata.json
1.0.0 - 2017-01-17
Added
- Official release of the ciscoyang module, supporting configuration of IOS-XR through Cisco supported YANG data models in JSON/XML format.
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright (c) 2014-2015 Cisco and/or its affiliates. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.