From 959646cb01cf5149b6c54855b4143f44aa4a213b Mon Sep 17 00:00:00 2001 From: rachelbritton Date: Wed, 5 Feb 2025 12:43:44 +0000 Subject: [PATCH 1/2] MM-30585. Added meraki synchronization parameters in settings. Added Meraki synchronization parameters to the System Settings documentation and links on the Meraki installation section and Cisco Meraki documentation. Simultaneously fixed stylization, formatting, and grammar across the affected files. --- guides/admin-manual/admin_system_settings.rst | 110 ++++++++++-------- guides/implementation/cloud.rst | 48 ++++---- guides/user-manual/cisco_meraki.rst | 43 +++---- guides/user-manual/networks.rst | 3 +- 4 files changed, 108 insertions(+), 96 deletions(-) diff --git a/guides/admin-manual/admin_system_settings.rst b/guides/admin-manual/admin_system_settings.rst index 8f85f6af..96764ca8 100644 --- a/guides/admin-manual/admin_system_settings.rst +++ b/guides/admin-manual/admin_system_settings.rst @@ -9,8 +9,8 @@ System Settings **To access the System Settings**: -#. On the **Admin** page, select :guilabel:`Configuration` in the upper-left corner. -#. Browse the categories under :guilabel:`System settings` in the filtering sidebar to find what you're looking for. +#. On the **Admin** page, select the :guilabel:`Configuration` tab. +#. Browse the categories under :guilabel:`System Settings` in the filtering sidebar to find what you're looking for. .. image:: ../../images/admin-system-settings-11.png :width: 80% @@ -38,7 +38,7 @@ The System Settings include the following categories: General ------- -Use the General settings to specify the following: +Use the **General** settings to specify the following: * Save Comments for Micetro. @@ -48,25 +48,25 @@ Use the General settings to specify the following: Save Comments ^^^^^^^^^^^^^^ -By default, users can save changes in the system without writing a comment. Here you have the option to set the comment requirements for Micetro tasks, including options to turn off the save comment dialog box, make it optional, or require it. +By default, users can save changes in the system without writing a comment. Here, you have the option to set the comment requirements for Micetro tasks, including options to turn off, make optional, or require the **Save Comment** dialog box. - * When **off** is selected, the save comment dialog box will not appear when users save changes. + * When **off** is selected, the **Save Comment** dialog box will not appear when users save changes. * If you choose to make comments **optional**, users can choose whether or not to include a comment when saving changes. - * If you choose to make comments **required**, users will need to include a comment whenever they save changes. + * If you choose to make comments **required**, users must include a comment whenever they save changes. AD Sites and Subnets ^^^^^^^^^^^^^^^^^^^^^^ Enable AD sites and subnets integration - When selected, all AD sites and their corresponding subnets will be displayed in Micetro, and you can add and remove subnets from sites and move subnets between different sites as needed. AD sites and subnets will be listed on the **AD Sites** menu on the IPAM page. + When selected, all Active Directory (AD) sites and their corresponding subnets will be displayed in Micetro, and you can add and remove subnets from sites and move subnets between different sites as needed. AD sites and subnets will be listed on the **AD Sites** menu on the **IPAM** page. - If you want to synchronize the Location and Description fields of the subnets in Active Directory with custom properties in Micetro, choose the desired custom properties to synchronize against. When synchronization is active, any changes made to the fields in Active Directory will automatically update the corresponding fields in Micetro, and vice versa. See :ref:`active-directory`. + If you want to synchronize the Location and Description fields of the subnets in AD with custom properties in Micetro, choose the desired custom properties to synchronize with. When synchronization is active, any changes made to the fields in AD will automatically update the corresponding fields in Micetro and vice versa. See :ref:`active-directory`. -Enforce AD site inheritance. +Enforce AD site inheritance Select this checkbox if you want to enforce site inheritance in AD. When site inheritance is enforced, child subnets must reside in the same site as the parent subnet. If site inheritance is not enforced, child subnets can be placed in different sites than the parent subnet. See :ref:`active-directory`. Determine Address Usage ^^^^^^^^^^^^^^^^^^^^^^^ -Control how IP addresses are identified as being in use. By default, these settings are all selected. To specify which rules should be applied to IP addresses and get a more granular picture of where the usage is coming from, select/clear the appropriate checkboxes. +Control how IP addresses are identified as being in use. By default, these settings are all selected. To specify which rules should be applied to IP addresses and get a more granular picture of where the usage is occurring, select/clear the appropriate checkboxes. .. _admin-authentication: @@ -74,22 +74,22 @@ Authentication -------------- Configure authentication methods, including single sign-on, LDAP integration, and external login providers. -When **single sign-on** is activated, users do not have to authenticate when logging in to Micetro. For more information about Single sign-on, see :ref:`webapp-external-auth`. +When **single sign-on** is activated, users do not need to authenticate when logging in to Micetro. For more information about single sign-on, see :ref:`webapp-external-auth`. External Authentication ^^^^^^^^^^^^^^^^^^^^^^^ -Allow users to log in to Micetro using credentials from Okta or Azure AD. The :guilabel:`Configure` button opens a form where you can set enter the necessary information needed for Okta or Azure AD authentication. +Allow users to log into Micetro using credentials from Okta or Azure AD. The :guilabel:`Configure` button opens a form where you can enter the necessary information needed for Okta or Azure AD authentication. Decide how login options appear on the Micetro login page. Validate signature of external authentication script before running - This feature only has an effect when single sign-on is enabled. It ensures the security of the authentication process by confirming the authenticity of external authentication scripts before executing them. + This feature only takes effect when single sign-on is enabled. It ensures the security of the authentication process by confirming the authenticity of external authentication scripts before executing them. .. _admin-logging: Logging ------- -The Logging settings allow you to specify when log messages should be deleted and whether lease history for DHCP servers should be collected. +The Logging settings allow you to specify when log messages should be deleted and whether a lease history for DHCP servers should be collected. Micetro Log ^^^^^^^^^^^^ @@ -107,9 +107,9 @@ Log extra information when address collection is triggered Lease History ^^^^^^^^^^^^^^ -Here you can select to start collecting lease history for DHCP servers. By viewing the DHCP lease history, you can quickly identify any potential issues or conflicts. +Here, you can select to start collecting lease history for DHCP servers. By viewing the DHCP lease history, you can quickly identify any potential issues or conflicts. -You can specify the number of days to keep the history before it is deleted, and if you want to save the history to a comma separated text file before it is deleted, enter a name for the file in the **Flush lease history to file before purging** text box. +You can specify the number of days to keep the history before it is deleted and, if you want to save the history to a comma-separated text file before it is deleted, enter a name for the file in the **Flush lease history to file before purging** text box. .. _admin-error-checking: @@ -127,19 +127,19 @@ Ignore missing reverse zones. DNS --- -Use these settings to specify various DNS related settings. +Use the following settings to specify various DNS-related settings: Delegation Records ^^^^^^^^^^^^^^^^^^^ -When activated, Micetro will automatically create delegation records (NS records) in the corresponding parent zones whenever subzones are created. This ensures that the delegation chain between parent and subzones is maintained correctly. +When activated, Micetro will automatically create delegation records (NS records) in the corresponding parent zones whenever subzones are created. This ensures that the delegation chain between parent and subzone is correctly maintained. Adjust Zone Transfer ^^^^^^^^^^^^^^^^^^^^ -Allow Micetro to automatically adjust zone transfer settings on Microsoft DNS servers to enable management of dynamic and Active Directory integrated zones. +Allow Micetro to automatically adjust zone transfer settings on Microsoft DNS servers to enable management of dynamic and Active Directory integrated zones. Enabling this setting also allows secondary zones to be opened from within Micetro. DNSSEC ^^^^^^ -Include derived DNSSEC records when viewing DNSSEC signed zones in Micetro. Note that this will significantly increase the size of the Micetro database and may affect overall system performance. +Include derived DNSSEC records when viewing DNSSEC-signed zones in Micetro. Note that this will significantly increase the size of the Micetro database and may affect overall system performance. .. _admin-ipam: @@ -147,11 +147,11 @@ Include derived DNSSEC records when viewing DNSSEC signed zones in Micetro. Note IPAM ---- -Specify various IPAM related settings: +Specify various IPAM-related settings, including: * How the system should handle new subranges if the parent range is in a folder. - * How the system should behave when naming conflicts between existing IP Address ranges and DHCP scopes occur. + * How the system should behave when naming conflicts between existing IP address ranges and DHCP scopes occur. * How the system should behave if DHCP scopes are removed outside Micetro. @@ -163,17 +163,20 @@ Subranges Name conflicts between ranges and scopes Specify what happens if the name of an MS DHCP scope does not match the name of an existing IP address range. -Apply same rule for scope description as for scope name above. +Apply same rule for scope description as for scope name above When selected, the system will use the same rules to update scope description as it does for updating scope names. -Allow reservations inside pools on ISC DHCP servers. +When a DHCP scope is deleted outside Micetro + Select whether a scope deleted outside Micetro is converted to an IP address range or also deleted from Micetro. + +Allow reservations inside pools on ISC DHCP servers When selected, the system allows users to create reservations inside pools on ISC DHCP servers. When a reservation is created inside a pool, the pool is split to make space for the reservation. .. warning:: - If a reservation that has been created inside a pool is deleted, the address is not made a part of the pool again. + If a reservation created inside a pool is deleted, the address is not made a part of the pool again. Allow allocation of IP addresses from IP Address Containers - When selected, the system will allow allocation of IP addresses that reside in IP address Containers. For more information on IP address Containers, refer to :ref:`ipam-containers`. + When selected, the system will allow allocation of IP addresses that reside in IP Address Containers. For more information on IP Address Containers, refer to :ref:`ipam-create-network`. Disable scanning of VRF information By default, the system does not scan for VRF information. If you clear the checkbox, the system will begin scanning for VRF information. If an overlap is found between different VRFs, the system will log the issue. @@ -186,34 +189,34 @@ Always show discovery info Monitoring ---------- -Specify various monitoring related settings. +Specify various monitoring-related settings, including the following: Subnet Monitoring ^^^^^^^^^^^^^^^^^ Enable subnet monitoring - When enabled, the system monitors the free addresses in DHCP address pools and subnets and performs an action if the number of free addresses goes below a user-definable threshold. For further configuration, see :ref:`admin-subnet-monitoring-events`. + When enabled, the system monitors the free addresses in DHCP address pools and subnets and performs an action if the number of free addresses drops below a user-definable threshold. For further configuration, see :ref:`admin-subnet-monitoring-events`. .. note:: - The global subnet monitoring setting can be overridden for individual subnets by changing the setting explicitly for the subnet. Refer to IP Address Management—Subnet Monitoring and Utilization History for information on how to change monitoring settings for individual subnets. + The global subnet monitoring setting can be overridden for individual subnets by changing the setting explicitly for the subnet. Refer to :ref:`ipam-subnet-monitoring` for information on how to change monitoring settings for individual subnets. -When subnet monitoring is enabled, a new column, Monitoring, displays when viewing the subnet list. To quickly see all subnets that are monitored, you can use the Quick Filter and filter by this column by entering "Monitor: Yes" in the Quick Filter search field. +When subnet monitoring is enabled, a new **Monitoring** column is displayed when viewing the subnet list. To quickly see all subnets that are monitored, you can use the :guilabel:`Quick filter` and filter by this column by entering "Monitor: Yes" in the :guilabel:`Quick Filter` search field. .. note:: - Only DHCP scopes that are enabled are monitored. Disabled scopes are ignored. + Only enabled DHCP scopes are monitored. Disabled scopes are ignored. -When subnet monitoring is enabled, you must specify the mail server and the sender e-mail address to use if you want the subnet monitor to send an e-mail. Place the appropriate information in the SMTP Server and Mail from fields. +When subnet monitoring is enabled, you must specify the mail server and the sender email address to use if you want the subnet monitor to send an email. Enter the appropriate information in the **SMTP server** and **Mail from** fields. Select :guilabel:`Set Default Monitor` to make this the default monitor. -Enable sending SNMP traps. - When enabled, the system will send SNMP traps when certain events occur: +Enable sending SNMP traps + When enabled, the system will send SNMP traps when certain events occur, including: - * When the number of free IP Addresses in monitored subnets goes below a user-definable threshold. + * When the number of free IP addresses in monitored subnets drops below a user-definable threshold. - * When a log event of type Error or Notice occurs. Refer to :ref:`admin-logging` for more information on log events. + * When a log event of type *Error* or *Notice* occurs. Refer to :ref:`admin-logging` for more information on log events. - When enabling sending of SNMP traps, you must provide additional information: + When enabling sending of SNMP traps, you must provide the following information: * Manager name - Enter the host name of the computer that should receive the SNMP traps. + Enter the hostname of the computer that should receive the SNMP traps. * Manager port Enter the port number the Manager uses for the SNMP traps. @@ -223,7 +226,7 @@ Enable sending SNMP traps. Service Monitoring ^^^^^^^^^^^^^^^^^^^ -When selected, the monitoring tool monitors the DNS and DHCP services on their respective servers. Decide on an appropriate interval for monitoring. +When selected, the monitoring tool monitors the DNS and DHCP services on their respective servers. Enter an appropriate interval (in minutes) for monitoring. .. _admin-advanced: @@ -242,7 +245,7 @@ Here you can configure advanced system settings, such as specifying a SSL Certif "**SOA record defaults in new zones**", "TTL of SOA record", "Specifies the default TTL (Time to Live) value to use for the SOA record of new zones." "Hostmaster", "Specifies the default value to use for the Hostmaster field in the SOA record of new zones." - "Refresch", "Specifies the default value to use for the Refresh field in the SOA record of new zones." + "Refresh", "Specifies the default value to use for the Refresh field in the SOA record of new zones." "Retry", "Specifies the default value to use for the Retry field in the SOA record of new zones." "Expire", "Specifies the default value to use for the Expiry field in the SOA record of new zones." "Negative caching (BIND)", "Specifies the default value to use for the Negative Caching field in the SOA record of new zones. Only applicable for zones on BIND DNS servers." @@ -250,30 +253,35 @@ Here you can configure advanced system settings, such as specifying a SSL Certif "**Web proxy**" "Web proxy to use", "Specifies a proxy server to be used for outgoing connections for checking for updates and additionally for AWS cloud services." "Web proxy port (defaults to port 80)", "Specifies the port of the proxy server to be used for outgoing connections for checking for updates and additionally for AWS cloud services." - "Password for web proxy authentication", "Specifies a cleartext password for proxy sign in." - "Use web proxy settings when connecting to AWS", "If selected, the proxy settings configured will be used for connections to AWS." - "", - "Directory for scripts that can be run from the API", "Specifies the directory that contains scripts that may be run from the API." + "Username for web proxy authentication", "Specifies a username for proxy sign-in" + "Password for web proxy authentication", "Specifies a cleartext password for proxy sign-in." + "Use web proxy settings when connecting to AWS", "If selected, the configured proxy settings will be used for connections to AWS." + "**Cisco Meraki**" + "Network client synchronization interval in seconds", "Specifies the amount of time, in seconds, it takes for the network to fetch all Meraki clients." + "Configuration synchronization interval in seconds", "Specifies the amount of time, in seconds, between fetches of all non-client-related information, e.g., networks, subnets, etc." + "Throttling max wait time in seconds", "Specifies the maximum wait time, in seconds, after a ``429 Too many requests`` response. Default behavior follows the maximum value suggested in the Meraki API response." + "API server error default wait time in seconds", "Specifies the wait time, in seconds, after receiving ``5xx`` error responses." + "**Miscellaneous**" + "Folder for scripts that can be run from the API", "Specifies the directory that contains scripts that may be run from the API." "Log performance of API calls", "Determines whether execution time of API calls should be logged. Mainly used for diagnostic purposes." "Time in minutes between write-outs of API call performance log", "If logging of API query performance is enabled, this setting specifies how frequently the log should be written to disk." "Automatically adjust local zone transfer settings for BIND", "When enabled, BIND can automatically optimize the settings related to local (within your network) zone transfers." "Automatically create reverse (PTR) records", "When selected, Micetro automatically creates reverse (PTR) records. PTR records are used for reverse DNS lookups, which are used to resolve an IP address to a domain name." "Perform backup of MS and ISC DHCP servers", "Determines whether to perform a backup of Microsoft (MS) and Internet Systems Consortioum (ISC) Dynamic Host Configuration Protocol (DHCP) servers." "Default TTL to use for DNS records created in zones for all xDNS profiles", "Specifies the default TTL (Time to Live) value to use for DNS records created in zones for all xDNS profiles." - "Disable all health checks", "If selected, all health checks will be disabled." + "Disable all health checks", "Select to disable all health checks." "Disable collection of statistical information", "Select to stop the collection of statistical information." "Use Azure activity log to optimize DNS synchronization", "When enabled, the Azure activity log is monitored for events related to DNS changes, and those changes are synchronized with the DNS server in real-time." "Use AWS CloudTrail events to optimize DNS synchronization", "Determines whether AWS CloudTrail events should be used to optimize DNS synchronization." - "IP ranges/scopes inherit access by default", "When you create a new IP range or scope, it will ineherit all access bits form its parent by default. If you want to change this behavior, clear this checkbox." + "IP ranges/scopes inherit access by default", "When you create a new IP range or scope, it will inherit all access bits form its parent by default. If you want to change this behavior, clear this checkbox." "Maximum number of blocks that can be temporarily claimed", "Limits the number of blocks that can be temporarily reserved or allocated for use by a specific user." "Enable collection of IP information from routers", "Determines whether the system can collect IP information from the ARP cache of routers. If selected, the system can collect this information." - "Timeout in seconds for named-checkconf", "Specifies the timeout value in seconds for named-checkonf files." + "Timeout in seconds for named-checkconf", "Specifies the timeout value, in seconds, for named-checkonf files." "Synchronize DNSSEC signed zones immediately after editing", "Determines whether DNSSEC signed zones should be synchronized immediately after they are changed. If selected, the zones are synchronized immediately. [1]_" "Use case sensitive comparison when updating custom properties from scripts", "Specifies whether to take case sensitivity into account when comparing custom properties from scripts." - "Include A/AAAA records when checking for *Edit apex records* access", "Determines whether A and AAAA records are considered when verifying access to edit apex (root) records." - "Web app landing page", "By default, the Micetro frontpage is the landing page for the system. Clicking the Micetro logo will take you to the landing page." - "Web app server host", "Used to specify which host the web application is running on in order for auto update to work for the web application. Default is localhost (same server as Micetro Central)" + "Include A/AAAA records when checking for *Edit apex records access*", "Determines whether A and AAAA records are considered when verifying access to edit apex (root) records." + "Web app landing page", "By default, the Micetro homepage is the landing page for the system. You can change the landing page, if desired, to either the DNS or IPAM page. Clicking the Micetro logo will take you to the landing page." + "Web app server host", "Used to specify which host the web application is running on in order for auto update to work for the web application. Default is localhost (same server as Micetro Central)." .. [1] Enabling this feature can affect the performance of the system. - diff --git a/guides/implementation/cloud.rst b/guides/implementation/cloud.rst index 137bc634..5f0e0275 100644 --- a/guides/implementation/cloud.rst +++ b/guides/implementation/cloud.rst @@ -8,7 +8,7 @@ Cloud Integration ***************** Micetro provides native integration with cloud-based DNS and DHCP services, managing IP address data for Azure and AWS, including virtual networks and subnets within cloud accounts. -Using a cloud DNS service in Micetro is similar to the process of working with other DNS services. The process of adding DNS zones, DNS records, or modifying them is identical to that of other DNS servers in Micetro. +Using a cloud DNS service in Micetro is similar to working with other DNS services. The process of adding DNS zones, DNS records, or modifying them is identical to that of other DNS servers in Micetro. .. note:: Currently, cloud DNS services only support the creation of primary zones. @@ -23,7 +23,7 @@ Supported Cloud Services :header: "Cloud service", "DNS", "IPAM" :widths: 10, 30, 30 - "Akamai", "Yes (Akamai Fast DNS)", "N/A" + "Akamai", "Yes (Akamai Edge DNS)", "N/A" "Azure", "Yes (Azure DNS)", "Yes" "Amazon Web Services (AWS)", "Yes (Amazon Route 53)", "Yes" "NS1", "Yes", "N/A" @@ -54,23 +54,24 @@ If you intend to add multiple AWS cloud accounts using a single set of credentia Adding Cloud Services ^^^^^^^^^^^^^^^^^^^^^^ -You must have permission to administer DNS or DHCP to add a new service to Micetro. +.. note:: + You must have permission to administer DNS or DHCP to add a new service to Micetro. **To add a cloud service**: -1. On the **Admin** page, select :guilabel:`Service Management` in the upper-left corner. +1. On the **Admin** page, select the :guilabel:`Service Management` tab. 2. Select :guilabel:`Add Service`. -3. Select the cloud provider you want to use, fill in the required information, and select :guilabel:`Add`. +3. Select the cloud provider you want to use, enter the required information, and select :guilabel:`Add`. .. image:: ../../images/add-servive-dialog.png :width: 50% -4. The service and any subnets defined will be displayed under DNS Services or DHCPS Service and IP Ranges, respectively. +4. The service and any subnets defined will be displayed under DNS Services or DHCP Services and IP Ranges, respectively. -Akamai Fast DNS +Akamai Edge DNS """""""""""""""" -Fill in the fields required to connect to Akamai Fast DNS: +Fill out the fields required to connect to Akamai Edge DNS: .. image:: ../../images/add-edge-dns.png :width: 50% @@ -81,24 +82,24 @@ Fill in the fields required to connect to Akamai Fast DNS: Akamai OPEN APIs are time sensitive! It is crucial to synchronize the system your client operates on with a Stratum 2 or higher time source. .. danger:: - If the time on the server running the DNS Remote differs significantly from Coordinated Universal Time, authentication will fail preventing access/updating of zones through Micetro. + If the time on the server running the DNS Remote differs significantly from Coordinated Universal Time, authentication will fail, preventing access/updating of zones through Micetro. .. _connect-azure: Azure DNS """""""""" -Fill in the fields required to connect to Azure: +Fill out the fields required to connect to Azure: .. image:: ../../images/add-azure-dns.png :width: 50% -* For information about how to configure Azure DNS, see :ref:`configure-azure-dns`. +For information about how to configure Azure DNS, see :ref:`configure-azure-dns`. .. _connect-aws: -Amazon Web Services -""""""""""""""""""" -Fill in the fields required to connect to AWS: +Amazon Web Services (AWS) +""""""""""""""""""""""""" +Fill out the fields required to connect to AWS: .. image:: ../../images/add-aws.png :width: 50% @@ -114,34 +115,36 @@ Fill in the fields required to connect to AWS: NS1 """ -Fill in the fields required to connect to NS1: +Fill out the fields required to connect to NS1: .. image:: ../../images/add-ns1.png :width: 50% -* **Obtaining Access Credentials**: For information about how to create API Access Credentials for use by Micetro, see `IBM NS1 Connect `_. +* **Obtaining Access Credentials**: For information about how to create API Access Credentials for use by Micetro, see `IBM NS1 Connect `_. .. _connect-meraki: Cisco Meraki """""""""""" -To manage Meraki with Micetro, it is required to have an operational instance of the Micetro DHCP Agent. For additional details about the DHCP Agent, see :ref:`install-dhcp-controllers`. Moreover, the user responsible for adding Meraki should have DHCP administrator privileges. +To manage Meraki with Micetro, an operational instance of the Micetro DHCP Agent is required. For additional details about the DHCP Agent, see :ref:`install-dhcp-controllers`. Moreover, the user responsible for adding Meraki should have DHCP administrator privileges. -When connecting to Meraki, you need to sepcify the location of the running DHCP. Next you must provide Micetro with a display name for the service and the API key to connect to Meraki. +When connecting to Meraki, you must specify the location of the running DHCP. Next, provide Micetro with a display name for the service and the API key to connect to Meraki. .. image:: ../../images/add-meraki.png :width: 50% * **Obtaining Access Credentials**: For information about how to create API Access Credentials for use by Micetro, see `Cisco Meraki Dashboard API `_. +Synchronization parameters, e.g., network client synchronization interval, can be configured under :ref:`Advanced System Settings `. + Editing Cloud Services ----------------------- **To edit the properties of a cloud service**: -1. In the **Service Management** area, locate the service you want to edit. -2. Double-click the service or select it, and then select :guilabel:`Edit service` on the :guilabel:`Action` menu. -3. Make the necessary changes and select :guilabel:`Confirm`. +1. On the **Service Management** tab, locate the service you want to edit. +2. Double-click the service or select it, and then select :guilabel:`Edit service properties` on the :guilabel:`Action` menu. +3. Make the necessary changes and select :guilabel:`Save`. Removing Cloud Services ------------------------ @@ -150,7 +153,7 @@ Removing Cloud Services **To remove a cloud service**: -1. In the **Service Management** area, select the service you want to remove. +1. On the **Service Management** tab, select the service you want to remove. 2. On the :guilabel:`Action` menu, select :guilabel:`Remove DNS service`. @@ -170,4 +173,3 @@ Removing Cloud Networks * :ref:`cloud-minimum-permissions` * :ref:`configure-azure-dns` - diff --git a/guides/user-manual/cisco_meraki.rst b/guides/user-manual/cisco_meraki.rst index 25e0920a..beeae4b3 100644 --- a/guides/user-manual/cisco_meraki.rst +++ b/guides/user-manual/cisco_meraki.rst @@ -11,11 +11,12 @@ Cisco Meraki Micetro integrates with Cisco Meraki to organize and customize DDI for remote office networks. It helps coordinate and manage important IP resources and network data on the Cisco Meraki platform, such as IP ranges, addresses, VLANs, and DHCP settings. This ensures efficient mapping and management of these elements within the Micetro system. -This section provides an overview of managing your Meraki network infrastructure with Micetro. +An ``admin`` user can configure synchronization parameters for your Meraki integration in :ref:`Advanced System Settings`. +This section provides an overview of managing your Meraki network infrastructure with Micetro. .. tip:: - For information about how to set up a connection between Micetro and Meraki, see the instructions for :ref:`how to add a cloud service to Micetro`. + For information about how to set up a connection between Micetro and Meraki, see the instructions on :ref:`how to add a cloud service to Micetro`. Viewing Your Meraki Infrastructure ---------------------------------- @@ -25,13 +26,13 @@ When you have added your Meraki environment to Micetro, your networks will appea .. image:: ../../images/meraki/ipam-grid.png :width: 100% -VLANs and SingleLANs are displayed as scope instances in the IPAM view. The tabs at the bottom of the filtering sidebar on the left allow you to filter on a DHCP service level. Each Meraki network is displayed as a DHCP service, so you can use this filter to limit the view to the VLANs/SingleLans of a specific network: +VLANs and single LANs are displayed as scope instances on the **IPAM** view. The tabs at the bottom of the filtering sidebar on the left allow you to filter on a DHCP service level. Each Meraki network is displayed as a DHCP service, so you can use this filter to limit the view to the VLANs/single LANs of a specific network: .. image:: ../../images/meraki/ipam-grid-filtered.png :width: 100% -Double-clicking a scope in the IPAM view brings up the IP address view for that scope, where you can monitor the status of all IP addresses within it. -Network clients are shown as leases in the view. The IP address view is described in further details in :ref:`view-networks`. +Double-clicking a scope in the IPAM view opens the IP Address view for that scope, where you can monitor the status of all IP addresses within it. +Network clients are shown as leases in the view. For more information about the IP address view, see :ref:`view-networks`. .. image:: ../../images/meraki/range-view.png :width: 100% @@ -41,14 +42,14 @@ For more information about how Meraki data is displayed in Micetro, see :ref:`Ma Overlapping LANs ^^^^^^^^^^^^^^^^^^^ -In some Meraki environments, LANs on different networks may share same IP address range. When multiple LANs share the same IP range, they are displayed as overlapping scope instances in Micetro. +In some Meraki environments, LANs on different networks may share the same IP address range. When multiple LANs share the same IP range, they are displayed in Micetro as overlapping scope instances. .. image:: ../../images/meraki/scope-selector-1.png :width: 100% Double-clicking a scope opens a scope instance selector in the IP Address view. This selector allows you to switch between different instances of the scope. -Selecting a different scope instance updates the IP address view to show the status of the IP addresses for the selected instance. +Selecting a different scope instance updates the IP Address view to show the status of the IP addresses for the selected instance. .. image:: ../../images/meraki/scope-selector-2.png :width: 100% @@ -64,20 +65,20 @@ Because Micetro's connection with Meraki is bidirectional, you con perform some * :ref:`DHCP Exclusions` .. note:: - Micetro only allows updates to VLAN networks. For Single LAN networks, use the Meraki dashboard. + Micetro only allows updates to VLAN networks. For single LAN networks, use the Meraki dashboard. .. _reservations: Creating DHCP Reservations ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -You can create a DHCP reservation through the IP address view in Micetro. +You can create a DHCP reservation through the **IP Address** view in Micetro. -1. Select an IP address in the table and either click :guilabel:`Reserve` on the top toolbar or select :guilabel:`Create DHCP reservation` on the Row :guilabel:`...` menu for the IP address. +1. Select an IP address in the grid and either click :guilabel:`Reserve` on the top toolbar or select :guilabel:`Create DHCP reservation` on the Row :guilabel:`...` menu for the IP address. .. image:: ../../images/meraki/create-reservation1.png :width: 90% -2. Give the reservation a name and fill in the hardware address(MAC). +2. Give the reservation a Name and enter the Hardware Address (MAC). .. image:: ../../images/meraki/create-reservation2.png :width: 90% @@ -88,17 +89,17 @@ You can create a DHCP reservation through the IP address view in Micetro. Editing and Deleting Reservations """"""""""""""""""""""""""""""""" -You can also edit or delete a DHCP reservation through Micetro from the IP address view. +You can also edit or delete a DHCP reservation through Micetro from the **IP Address** view. **To edit or delete a reservation**: -1. Select an IP address that has an existing reservation in the table. -2. On the :guilabel:`Action` or Row :guilabel:`...` menu, select :guilabel:`Edit DHCP reservation` to modify the reservation or :guilabel:`Delete DHCP reservation(s)` to delete it. +1. Select an IP address that has an existing reservation in the grid. +2. Using the :guilabel:`Action` or Row :guilabel:`...` menu, select :guilabel:`Edit DHCP reservation` to modify the reservation or :guilabel:`Delete DHCP reservation(s)` to delete it. .. image:: ../../images/meraki/edit-delete-reservation.png :width: 90% -**To update or remove DHCP reservations through the API, use the following endpoints**: +**To update or delete DHCP reservations through the API, use the following endpoints**: * ``PUT /dhcpReservations/{dhcpReservationRef}`` @@ -112,13 +113,13 @@ You can manage your DHCP options on a scope level through Micetro. **To manage DHCP options** -1. Select the scope in the IPAM view. -2. On the :guilabel:`Action` or the Row :guilabel:`...` menu, select :guilabel:`Edit scope options`. +1. Select the scope in the **IPAM** view. +2. Using the :guilabel:`Action` or the Row :guilabel:`...` menu, select :guilabel:`Edit scope options`. .. image:: ../../images/meraki/edit-options-1.png :width: 90% -3. In the dialog box that opens, you can view the options for the scope and update them if necessary. +3. In the dialog box, you can view the options for the scope and update them, if necessary. .. image:: ../../images/meraki/edit-options-2.png :width: 60% @@ -137,7 +138,7 @@ You can manage excluded address ranges for your DHCP scopes through Micetro. 1. Select the relevant scope. -2. On :guilabel:`Action` or the Row :guilabel:`...` menu, select :guilabel:`Manage DHCP pools`. +2. Using the :guilabel:`Action` or the Row :guilabel:`...` menu, select :guilabel:`Manage DHCP pools`. 3. Click :guilabel:`Add exclusion`. @@ -155,9 +156,9 @@ Editing and Removing Exclusions **To edit or remove an existing exclusion**: -1. In the Manage DHCP pools dialog box, select the exclusion you want to edit or remove. +1. In the **Manage DHCP pools** dialog box, select the exclusion you want to edit or remove. -2. On the exclusion's row :guilabel:`...` menu, select :guilabel:`Edit` to modify the exclusion or :guilabel:`Remove` to delete it. +2. Using the exclusion's Row :guilabel:`...` menu, select :guilabel:`Edit` to modify the exclusion or :guilabel:`Remove` to delete it. **To update or remove DHCP exclusions through the API, use the following endpoints**: diff --git a/guides/user-manual/networks.rst b/guides/user-manual/networks.rst index c8996d69..e5df9eea 100644 --- a/guides/user-manual/networks.rst +++ b/guides/user-manual/networks.rst @@ -273,6 +273,7 @@ Subnet Discovery The subnet discovery feature enables Micetro to obtain information about the subnets on the network through routers using SNMP. To activate the subnet discovery feature, ensure that :guilabel:`Synchronize subnets ...` is selected in the SNMP profile. For more information about SNMP profiles, see :ref:`snmp-profiles`. +.. _ipam-subnet-monitoring: Setting Subnet Monitoring ------------------------- @@ -368,4 +369,4 @@ The system administrator can control which IP addresses users are permitted to u * :ref:`admin-change-events` * :ref:`snmp-profiles` * :ref:`webapp-workflows` -* :ref:`admin-system-settings` \ No newline at end of file +* :ref:`admin-system-settings` From f2d4ecc5f718d06143e285a6664ff0540ee10785 Mon Sep 17 00:00:00 2001 From: rachelbritton Date: Thu, 13 Feb 2025 11:51:39 +0000 Subject: [PATCH 2/2] MM-30585. Updated language. Co-authored-by: aebenesersson <166820778+aebenesersson@users.noreply.github.com> --- guides/admin-manual/admin_system_settings.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/admin-manual/admin_system_settings.rst b/guides/admin-manual/admin_system_settings.rst index 96764ca8..13f0aea1 100644 --- a/guides/admin-manual/admin_system_settings.rst +++ b/guides/admin-manual/admin_system_settings.rst @@ -257,7 +257,7 @@ Here you can configure advanced system settings, such as specifying a SSL Certif "Password for web proxy authentication", "Specifies a cleartext password for proxy sign-in." "Use web proxy settings when connecting to AWS", "If selected, the configured proxy settings will be used for connections to AWS." "**Cisco Meraki**" - "Network client synchronization interval in seconds", "Specifies the amount of time, in seconds, it takes for the network to fetch all Meraki clients." + "Network client synchronization interval in seconds", "Specifies the amount of time, in seconds, between fetches of all Meraki clients." "Configuration synchronization interval in seconds", "Specifies the amount of time, in seconds, between fetches of all non-client-related information, e.g., networks, subnets, etc." "Throttling max wait time in seconds", "Specifies the maximum wait time, in seconds, after a ``429 Too many requests`` response. Default behavior follows the maximum value suggested in the Meraki API response." "API server error default wait time in seconds", "Specifies the wait time, in seconds, after receiving ``5xx`` error responses."