Capsman API paths (#126)

* api path support: caps-man datapath

Signed-off-by: Tomas Herfert <herfik>

* api path support: caps-man security

Signed-off-by: Tomas Herfert <herfik>

* api path support: caps-man configuration

Signed-off-by: Tomas Herfert <herfik>

* api path support: caps-man access-list

Signed-off-by: Tomas Herfert <herfik>

* api path support: caps-man manager

Signed-off-by: Tomas Herfert <herfik>

* api path support: caps-man provisioning

Signed-off-by: Tomas Herfert <herfik>

* docs & changelog

Signed-off-by: Tomas Herfert <herfik>

* yamllint fix

Signed-off-by: Tomas Herfert <herfik>

Signed-off-by: Tomas Herfert <herfik>
Co-authored-by: Tomas Herfert <herfik>

changelogs/fragments/126-api-capsman.yml

@@ -0,0 +1,3 @@
+minor_changes:
+  - api_modify, api_info - support API paths ``caps-man access-list``, ``caps-man configuration``, ``caps-man datapath``, ``caps-man manager``, ``caps-man provisioning``, ``caps-man security``
+    (https://github.com/ansible-collections/community.routeros/pull/126).

plugins/module_utils/_api_data.py

@@ -499,6 +499,114 @@ PATHS = {
             'mac-mode': KeyInfo(default='as-username'),
         },
     ),
+    ('caps-man', 'access-list'): APIData(
+        fully_understood=True,
+        fields={
+            'action': KeyInfo(can_disable=True),
+            'allow-signal-out-of-range': KeyInfo(can_disable=True),
+            'ap-tx-limit': KeyInfo(can_disable=True),
+            'client-to-client-forwarding': KeyInfo(can_disable=True),
+            'client-tx-limit': KeyInfo(can_disable=True),
+            'comment': KeyInfo(can_disable=True, remove_value=''),
+            'disabled': KeyInfo(),
+            'interface': KeyInfo(can_disable=True),
+            'mac-address': KeyInfo(can_disable=True),
+            'mac-address-mask': KeyInfo(can_disable=True),
+            'private-passphrase': KeyInfo(can_disable=True),
+            'radius-accounting': KeyInfo(can_disable=True),
+            'signal-range': KeyInfo(can_disable=True),
+            'ssid-regexp': KeyInfo(),
+            'time': KeyInfo(can_disable=True),
+            'vlan-id': KeyInfo(can_disable=True),
+            'vlan-mode': KeyInfo(can_disable=True),
+        },
+    ),
+    ('caps-man', 'configuration'): APIData(
+        fully_understood=True,
+        primary_keys=('name', ),
+        fields={
+            'channel': KeyInfo(can_disable=True),
+            'channel.band': KeyInfo(can_disable=True),
+            'channel.control-channel-width': KeyInfo(can_disable=True),
+            'channel.extension-channel': KeyInfo(can_disable=True),
+            'channel.frequency': KeyInfo(can_disable=True),
+            'channel.reselect-interval': KeyInfo(can_disable=True),
+            'channel.save-selected': KeyInfo(can_disable=True),
+            'channel.secondary-frequency': KeyInfo(can_disable=True),
+            'channel.skip-dfs-channels': KeyInfo(can_disable=True),
+            'channel.tx-power': KeyInfo(can_disable=True),
+            'comment': KeyInfo(can_disable=True, remove_value=''),
+            'country': KeyInfo(can_disable=True),
+            'datapath': KeyInfo(can_disable=True),
+            'datapath.arp': KeyInfo(),
+            'datapath.bridge': KeyInfo(can_disable=True),
+            'datapath.bridge-cost': KeyInfo(can_disable=True),
+            'datapath.bridge-horizon': KeyInfo(can_disable=True),
+            'datapath.client-to-client-forwarding': KeyInfo(can_disable=True),
+            'datapath.interface-list': KeyInfo(can_disable=True),
+            'datapath.l2mtu': KeyInfo(),
+            'datapath.local-forwarding': KeyInfo(can_disable=True),
+            'datapath.mtu': KeyInfo(),
+            'datapath.openflow-switch': KeyInfo(can_disable=True),
+            'datapath.vlan-id': KeyInfo(can_disable=True),
+            'datapath.vlan-mode': KeyInfo(can_disable=True),
+            'disconnect-timeout': KeyInfo(can_disable=True),
+            'distance': KeyInfo(can_disable=True),
+            'frame-lifetime': KeyInfo(can_disable=True),
+            'guard-interval': KeyInfo(can_disable=True),
+            'hide-ssid': KeyInfo(can_disable=True),
+            'hw-protection-mode': KeyInfo(can_disable=True),
+            'hw-retries': KeyInfo(can_disable=True),
+            'installation': KeyInfo(can_disable=True),
+            'keepalive-frames': KeyInfo(can_disable=True),
+            'load-balancing-group': KeyInfo(can_disable=True),
+            'max-sta-count': KeyInfo(can_disable=True),
+            'mode': KeyInfo(can_disable=True),
+            'multicast-helper': KeyInfo(can_disable=True),
+            'name': KeyInfo(),
+            'rates': KeyInfo(can_disable=True),
+            'rates.basic': KeyInfo(can_disable=True),
+            'rates.ht-basic-mcs': KeyInfo(can_disable=True),
+            'rates.ht-supported-mcs': KeyInfo(can_disable=True),
+            'rates.supported': KeyInfo(can_disable=True),
+            'rates.vht-basic-mcs': KeyInfo(can_disable=True),
+            'rates.vht-supported-mcs': KeyInfo(can_disable=True),
+            'rx-chains': KeyInfo(can_disable=True),
+            'security': KeyInfo(can_disable=True),
+            'security.authentication-types': KeyInfo(can_disable=True),
+            'security.disable-pmkid': KeyInfo(can_disable=True),
+            'security.eap-methods': KeyInfo(can_disable=True),
+            'security.eap-radius-accounting': KeyInfo(can_disable=True),
+            'security.encryption': KeyInfo(can_disable=True),
+            'security.group-encryption': KeyInfo(can_disable=True),
+            'security.group-key-update': KeyInfo(),
+            'security.passphrase': KeyInfo(can_disable=True),
+            'security.tls-certificate': KeyInfo(),
+            'security.tls-mode': KeyInfo(),
+            'ssid': KeyInfo(can_disable=True),
+            'tx-chains': KeyInfo(can_disable=True),
+        },
+    ),
+    ('caps-man', 'datapath'): APIData(
+        fully_understood=True,
+        primary_keys=('name', ),
+        fields={
+            'arp': KeyInfo(),
+            'bridge': KeyInfo(can_disable=True),
+            'bridge-cost': KeyInfo(can_disable=True),
+            'bridge-horizon': KeyInfo(can_disable=True),
+            'client-to-client-forwarding': KeyInfo(can_disable=True),
+            'comment': KeyInfo(can_disable=True, remove_value=''),
+            'interface-list': KeyInfo(can_disable=True),
+            'l2mtu': KeyInfo(),
+            'local-forwarding': KeyInfo(can_disable=True),
+            'mtu': KeyInfo(),
+            'name': KeyInfo(),
+            'openflow-switch': KeyInfo(can_disable=True),
+            'vlan-id': KeyInfo(can_disable=True),
+            'vlan-mode': KeyInfo(can_disable=True),
+        },
+    ),
     ('caps-man', 'manager', 'interface'): APIData(
         unknown_mechanism=True,
         # primary_keys=('default', ),
@@ -509,6 +617,41 @@ PATHS = {
             'interface': KeyInfo(),
         },
     ),
+    ('caps-man', 'provisioning'): APIData(
+        fully_understood=True,
+        fields={
+            'action': KeyInfo(default='none'),
+            'comment': KeyInfo(can_disable=True, remove_value=''),
+            'common-name-regexp': KeyInfo(default=''),
+            'disabled': KeyInfo(default=False),
+            'hw-supported-modes': KeyInfo(default=''),
+            'identity-regexp': KeyInfo(default=''),
+            'ip-address-ranges': KeyInfo(default=''),
+            'master-configuration': KeyInfo(default='*FFFFFFFF'),
+            'name-format': KeyInfo(default='cap'),
+            'name-prefix': KeyInfo(default=''),
+            'radio-mac': KeyInfo(default='00:00:00:00:00:00'),
+            'slave-configurations': KeyInfo(default=''),
+        },
+    ),
+    ('caps-man', 'security'): APIData(
+        fully_understood=True,
+        primary_keys=('name', ),
+        fields={
+            'authentication-types': KeyInfo(can_disable=True),
+            'comment': KeyInfo(can_disable=True, remove_value=''),
+            'disable-pmkid': KeyInfo(can_disable=True),
+            'eap-methods': KeyInfo(can_disable=True),
+            'eap-radius-accounting': KeyInfo(can_disable=True),
+            'encryption': KeyInfo(can_disable=True),
+            'group-encryption': KeyInfo(can_disable=True),
+            'group-key-update': KeyInfo(),
+            'name': KeyInfo(),
+            'passphrase': KeyInfo(can_disable=True),
+            'tls-certificate': KeyInfo(),
+            'tls-mode': KeyInfo(),
+        }
+    ),
     ('certificate', 'settings'): APIData(
         single_value=True,
         fully_understood=True,
@@ -1948,6 +2091,7 @@ PATHS = {
     ),
     ('caps-man', 'manager'): APIData(
         single_value=True,
+        fully_understood=True,
         fields={
             'ca-certificate': KeyInfo(default='none'),
             'certificate': KeyInfo(default='none'),

plugins/modules/api_info.py

@@ -43,6 +43,12 @@ options:
     choices:
     # BEGIN PATH LIST
         - caps-man aaa
+        - caps-man access-list
+        - caps-man configuration
+        - caps-man datapath
+        - caps-man manager
+        - caps-man provisioning
+        - caps-man security
         - certificate settings
         - interface bridge
         - interface bridge port

plugins/modules/api_modify.py

@@ -48,6 +48,12 @@ options:
     choices:
     # BEGIN PATH LIST
         - caps-man aaa
+        - caps-man access-list
+        - caps-man configuration
+        - caps-man datapath
+        - caps-man manager
+        - caps-man provisioning
+        - caps-man security
         - certificate settings
         - interface bridge
         - interface bridge port