Initial work on edge_port role

geant/gap_ansible/playbooks/edge_port.yaml

+- name: Create Edge Port
+  hosts: all
+  gather_facts: false
+  roles:
+    - ../roles/edge_port

geant/gap_ansible/roles/edge_port/README.md

+Role Name
+=========
+
+A brief description of the role goes here.
+
+Requirements
+------------
+
+Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+
+Role Variables
+--------------
+
+A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+
+Dependencies
+------------
+
+A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+    - hosts: servers
+      roles:
+         - { role: username.rolename, x: 42 }
+
+License
+-------
+
+BSD
+
+Author Information
+------------------
+
+An optional section for the role authors to include contact information, or a website (HTML is not allowed).

geant/gap_ansible/roles/edge_port/defaults/main.yml

+---
+# defaults file for edge_port

geant/gap_ansible/roles/edge_port/handlers/main.yml

+---
+# handlers file for edge_port

geant/gap_ansible/roles/edge_port/meta/main.yml

+galaxy_info:
+  author: A. Kurbatov
+  description: GEANT Orchestration and Automation Team
+  company: GEANT
+
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: http://example.com/issue/tracker
+
+  # Choose a valid license ID from https://spdx.org - some suggested licenses:
+  # - BSD-3-Clause (default)
+  # - MIT
+  # - GPL-2.0-or-later
+  # - GPL-3.0-only
+  # - Apache-2.0
+  # - CC-BY-4.0
+  license: MIT
+
+  min_ansible_version: '2.10'
+
+  # If this a Container Enabled role, provide the minimum Ansible Container version.
+  # min_ansible_container_version:
+
+  galaxy_tags:
+    - network
+    # List tags for your role here, one per line. A tag is a keyword that describes
+    # and categorizes the role. Users find roles by searching for tags. Be sure to
+    # remove the '[]' above, if you add tags to this list.
+    #
+    # NOTE: A tag is limited to a single word comprised of alphanumeric characters.
+    #       Maximum 20 tags per role.
+
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.

geant/gap_ansible/roles/edge_port/tasks/compile.yaml

+---
+- name: Set ansible host to localhost to compile config when router is offline
+  when:
+    router.router_access_via_ts | ansible.builtin.bool
+  ansible.builtin.set_fact:
+    ansible_host: "localhost"
+    ansible_connection: local
+
+- name: Create a folder for all the things
+  ansible.builtin.file:
+    path: "/var/tmp/ansible_run_{{ opid }}"
+    state: directory
+    mode: '0755'
+  delegate_to: localhost
+
+- name: Print the template in "/var/tmp/ansible_run_{{ opid }}/edge_port.conf"
+  when: verb == "create"
+  ansible.builtin.template:
+    src: "{{ router.vendor }}/edge_port.j2"
+    dest: "/var/tmp/ansible_run_{{ opid }}/edge_port.conf"
+    lstrip_blocks: true
+    trim_blocks: true
+    mode: '0755'
+  delegate_to: localhost

geant/gap_ansible/roles/edge_port/tasks/deploy.yaml

+- name: Deploy PE base_config on "{{ inventory_hostname }}" [CHECK ONLY][NOKIA]
+  when: >-
+      dry_run | ansible.builtin.bool
+      and verb == "deploy_pe_base_config"
+  geant.gap_ansible.nokia_netconf_config:
+    format: xml
+    default_operation: merge
+    content: "{{ lookup('ansible.builtin.template', 'routers/{{ subscription.router.vendor }}/pe_promotion_base_config.j2') }}"
+    commit: true
+    validate: true
+  diff: true
+  register: output
+  check_mode: true
+
+- name: Deploy PE base VPRNs on "{{ inventory_hostname }}" [CHECK ONLY][NOKIA]
+  when: >-
+      dry_run | ansible.builtin.bool
+      and verb == "deploy_routing_instances"
+  geant.gap_ansible.nokia_netconf_config:
+    format: xml
+    default_operation: merge
+    content: "{{ lookup('ansible.builtin.template', 'routers/{{ subscription.router.vendor }}/pe_promotion_base_vprn.j2') }}"
+    commit: true
+    validate: true
+  diff: true
+  register: output
+  check_mode: true
+
+- name: Deploy SDP mesh on "{{ inventory_hostname }}" [CHECK ONLY][NOKIA]
+  when: >-
+      dry_run | ansible.builtin.bool
+      and verb == "update_sdp_mesh"
+  geant.gap_ansible.nokia_netconf_config:
+    format: xml
+    default_operation: merge
+    content: "{{ lookup('ansible.builtin.template', 'routers/{{ subscription.router.vendor }}/pe_update_sdp.j2') }}"
+    commit: true
+    validate: true
+  diff: true
+  register: output
+  check_mode: true
+
+- name: Delete default routes on "{{ inventory_hostname }}" [CHECK ONLY][NOKIA]
+  when: >-
+      dry_run | ansible.builtin.bool
+      and verb == "delete_default_routes"
+  geant.gap_ansible.nokia_netconf_config:
+    format: xml
+    default_operation: merge
+    content: "{{ lookup('ansible.builtin.template', 'routers/{{ subscription.router.vendor }}/router/delete_default_static_routes.j2') }}"
+    commit: true
+    validate: true
+  diff: true
+  register: output
+  check_mode: true
+
+# - name: Fail if there is any diff
+#   ansible.builtin.fail:
+#     msg: Base config drift detected!!!
+#   when: >
+#     output.changed | ansible.builtin.bool
+#     and
+#     is_verification_workflow | ansible.builtin.bool
+
+- name: Deploy base_config on "{{ inventory_hostname }}" [AND COMMIT][NOKIA]
+  when: >-
+      not (dry_run | ansible.builtin.bool) and
+      verb == "deploy_pe_base_config"
+  geant.gap_ansible.nokia_netconf_config:
+    format: xml
+    default_operation: merge
+    content: "{{ lookup('ansible.builtin.template', 'routers/{{ subscription.router.vendor }}/pe_promotion_base_config.j2') }}"
+    commit: true
+    commit_comment: "{{ commit_comment }}"
+  diff: true
+  check_mode: false
+
+- name: Deploy PE base VPRNs on "{{ inventory_hostname }}" [AND COMMIT][NOKIA]
+  when: >-
+      not (dry_run | ansible.builtin.bool) and
+      verb == "deploy_routing_instances"
+  geant.gap_ansible.nokia_netconf_config:
+    format: xml
+    default_operation: merge
+    content: "{{ lookup('ansible.builtin.template', 'routers/{{ subscription.router.vendor }}/pe_promotion_base_vprn.j2') }}"
+    commit: true
+    commit_comment: "{{ commit_comment }}"
+  diff: true
+  check_mode: false
+
+- name: Deploy updated SDP mesh on "{{ inventory_hostname }}" [AND COMMIT][NOKIA]
+  when: >-
+      not (dry_run | ansible.builtin.bool) and
+      verb == "update_sdp_mesh"
+  geant.gap_ansible.nokia_netconf_config:
+    format: xml
+    default_operation: merge
+    content: "{{ lookup('ansible.builtin.template', 'routers/{{ subscription.router.vendor }}/pe_update_sdp.j2') }}"
+    commit: true
+    commit_comment: "{{ commit_comment }}"
+  diff: true
+  check_mode: false
+
+- name: Delete default routes on "{{ inventory_hostname }}" [AND COMMIT][NOKIA]
+  when: >-
+      not (dry_run | ansible.builtin.bool)
+      and verb == "delete_default_routes"
+  geant.gap_ansible.nokia_netconf_config:
+    format: xml
+    default_operation: merge
+    content: "{{ lookup('ansible.builtin.template', 'routers/{{ subscription.router.vendor }}/router/delete_default_static_routes.j2') }}"
+    commit: true
+    commit_comment: "{{ commit_comment }}"
+  diff: true
+  check_mode: false

geant/gap_ansible/roles/edge_port/tasks/main.yml

+---
+# tasks file for edge_port
+- name: Include Standard role tasks
+  ansible.builtin.include_tasks: standard_tasks.yaml
+
+- name: Include templates compilation
+  when: verb in verbs
+  ansible.builtin.include_tasks: compile.yaml
+
+# - name: Include deploy if selected
+#   when: verb in verbs
+#   ansible.builtin.include_tasks: deploy.yaml

geant/gap_ansible/roles/edge_port/tasks/standard_tasks.yaml

+---
+- name: Print the usage
+  when: (verb is not defined) or (verb not in verbs)
+  ansible.builtin.debug:
+    msg:
+      - "'verb' keyword is mandatory. Usage: -e verb=$verb"
+
+- name: Print defined verbs
+  when: (verb is not defined) or (verb not in verbs)
+  ansible.builtin.debug:
+    msg:
+      - "Allowed verb: {{ item }}"
+  loop: "{{ verbs }}"
+
+- name: Stop if arguments are incorrect
+  when: (verb is not defined) or (verb not in verbs)
+  ansible.builtin.meta: end_play
+
+- name: Import routers variables
+  ansible.builtin.include_vars:
+    dir: /opt/ansible_inventory/group_vars/routers
+
+- name: Import variables from 'all'
+  ansible.builtin.include_vars:
+    dir: /opt/ansible_inventory/group_vars/all
+
+- name: Set ansible_host to terminal server when router is offline
+  when: router.router_access_via_ts | ansible.builtin.bool
+  ansible.builtin.set_fact:
+    ansible_host: "{{ router.router_site.site_ts_address }}"
+    ansible_port: "{{ router.router_ts_port }}"
+
+- name: Load netconf connection config
+  ansible.builtin.set_fact:
+    ansible_connection: "{{ netconf_access[router.vendor].ansible_connection }}"
+    ansible_network_os: "{{ netconf_access[router.vendor].ansible_network_os }}"
+
+- name: Generate an ID for this run
+  ansible.builtin.set_fact:
+    opid: "{{ lookup('community.general.random_string', length=18, special=false) }}"
+
+- name: Print the ID
+  ansible.builtin.debug:
+    msg: "{{ opid }}"

geant/gap_ansible/roles/edge_port/templates/nokia/edge_port.j2

+<config xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:alu="urn:ietf:params:xml:ns:netconf:base:1.0">
+    <configure xmlns="urn:nokia.com:sros:ns:yang:sr:conf">
+
+{% for member in  edge_port_ae_members %}
+      <port xmlns="urn:nokia.com:sros:ns:yang:sr:conf" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nokia-attr="urn:nokia.com:sros:ns:yang:sr:attributes" alu:operation="replace">
+          <port-id>{{ member.interface_name }}</port-id>
+          <admin-state>enable</admin-state>
+          <description>PHY {{ edge_port_type }} {{ partner_name }} P_{{ edge_port_name }} |  {{ member.interface_description }}</description>
+          <ethernet>
+              <mode>access</mode>
+              <mtu>{{ mtu_phy | default(9192) }}</mtu>
+            {% if edge_port_lldp_enable_map[edge_port_type] is true %}  
+              <lldp>
+                  <dest-mac>
+                      <mac-type>nearest-bridge</mac-type>
+                      <receive>true</receive>
+                      <transmit>true</transmit>
+                      <tx-tlvs>
+                          <port-desc>true</port-desc>
+                          <sys-name>true</sys-name>
+                          <sys-cap>true</sys-cap>
+                      </tx-tlvs>
+                  </dest-mac>
+              </lldp>
+            {% endif %} 
+          </ethernet>
+      </port>
+{% endfor %}
+{% if edge_port_removed_ae_members is defined %}
+{% for member in edge_port_removed_ae_members %}
+      <port xmlns="urn:nokia.com:sros:ns:yang:sr:conf" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nokia-attr="urn:nokia.com:sros:ns:yang:sr:attributes" alu:operation="replace">
+          <port-id>{{ member.interface_name }}</port-id>
+          <admin-state>disable</admin-state>
+          <description>''</description>
+      </port>
+{% endfor %}
+{% endif %}
+      <lag xmlns="urn:nokia.com:sros:ns:yang:sr:conf" xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xmlns:nokia-attr="urn:nokia.com:sros:ns:yang:sr:attributes" alu:operation="replace">
+          <lag-name>{{ edge_port_name | lower }}</lag-name>
+          <admin-state>enable</admin-state>
+          <description>LAG  {{ edge_port_type }} {{ partner_name }} </description>
+          <mode>network</mode>
+         {% if edge_port_enable_lacp is true %} 
+          <lacp>
+              <mode>active</mode>
+              <administrative-key>{{ (edge_port_name|split("-"))[1] }}</administrative-key>
+          </lacp>
+          {% endif %}
+{% for member in edge_port_ae_members %}
+          <port>
+              <port-id>{{ member.interface_name }}</port-id>
+          </port>
+{% endfor %}
+          {% if ( edge_port_minimum_links | int) > 1 %}
+          <port-threshold>
+            <value>{{ ( edge_port_minimum_links | int) - 1 }}</value>
+            <action>down</action>
+          </port-threshold>
+          {% endif %}
+      </lag>
+  </configure>
+</config>

geant/gap_ansible/roles/edge_port/tests/inventory

+localhost
+

geant/gap_ansible/roles/edge_port/tests/test.yml

+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - edge_port

geant/gap_ansible/roles/edge_port/vars/main.yml

+---
+# vars file for edge_port
+dry_run: true
+
+verbs:
+  - create
+  - deploy # deploys an EdgePort
+  - delete # deletes an EdgePort
+  - migrate # migrates an EdgePort
+
+ep: "{{ subscription.edge_port }}"
+router: "{{ ep.edge_port_node }}"
+
+edge_port_node: "{{ subscription.edge_port.edge_port_node }}"
+edge_port_name: "{{ subscription.edge_port.edge_port_name }}"
+edge_port_description: "{{ subscription.edge_port.edge_port_description }}"
+edge_port_enable_lacp: "{{ subscription.edge_port.edge_port_enable_lacp }}"
+edge_port_encapsulation: "{{ subscription.edge_port.edge_port_encapsulation }}"
+# edge_port_mac_address: subscription.edge_port.edge_port_mac_address }}"
+edge_port_member_speed: "{{ subscription.edge_port.edge_port_member_speed }}"
+edge_port_minimum_links: "{{ subscription.edge_port.edge_port_minimum_links }}"
+edge_port_type: "{{ subscription.edge_port.edge_port_type }}"
+edge_port_ignore_if_down: "{{ subscription.edge_port.edge_port_ignore_if_down }}"
+edge_port_geant_ga_id: "{{ subscription.edge_port.edge_port_geant_ga_id }}"
+edge_port_ae_members: "{{ subscription.edge_port.edge_port_ae_members }}"
+
+edge_port_lldp_enable_map:
+  INFRASTRUCTURE: true
+  CUSTOMER: true
+  PUBLIC: false
+  RE_INTERCONNECT: false
+  PRIVATE: false