Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
_Hlk478509983
_Hlk478509983


User Guide
Yarnman –Orcamate – Engineer Toolkit

 

Anchor
_Toc8740030
_Toc8740030
Anchor
_Toc710806
_Toc710806
Anchor
_Toc513211404
_Toc513211404
Contents


Table of Contents



Anchor
_Toc8740031
_Toc8740031
UC Logs – On Demand

Supported systems

  • CUCM

  • IMP

  • UCXN

Select the cluster*, time period and servicesImage Removed

...

*Clusters need to be configured, this is performed under Administration App -> ClustersImage Removed

...

Anchor
_Toc8740032
_Toc8740032
Trace Levels

To check Trace Levels of CUCM services, select 'Check Trace Levels' buttonImage Removed

...

Anchor
_Toc8740033
_Toc8740033
UC Logs – Scheduled

The scheduled log collection push logs to a SFTP server

  • Set the start and end time

  • How often the schedule is run

  • Cluster

  • Interface(s)

  • Services

  • Log duration on UC app

  • SFTP interface

  • SFTP path files are stored in <customer>/<cluster>/<interface>/<time period>

...

Anchor
_Toc8740034
_Toc8740034
PRT upload

...

Anchor
_Toc8740035
_Toc8740035
Inventory EOL

Feature preview
Select interface and support account



Anchor
_Toc8740036
_Toc8740036
UC status

The UC status can be run for a specific interface or for a customer
It supports

  • CUCM

  • IMP

  • UCXN

  • EXPW

It can also check the Jabber DNS SRV records and certificates. Additional DNS servers and domains can be provided to test both public and internal records

If using customer option each of the UC applications is listed on the top

...

Anchor
_Toc8740039
_Toc8740039
Devices and Device Pools

...

Anchor
_Toc8740040
_Toc8740040
Database

...

Anchor
_Toc8740041
_Toc8740041
Services

...

Anchor
_Toc8740042
_Toc8740042
Certificates

...

Anchor
_Toc8740043
_Toc8740043
Expressway

Anchor
_Toc8740044
_Toc8740044
Alarms

...

Anchor
_Toc8740045
_Toc8740045
Connector Status

...

Anchor
_Toc8740046
_Toc8740046
Fault Finder

Fault finder can be run against a customer or a CUCM cluster – if there are multiple clusters in the customer it will query each cluster
Search can be done by

  • Device Name

  • Directory Number

  • E164

  • Username


Based on the search criteria if will find devices and if provided the user

...

Anchor
_Toc8740048
_Toc8740048
Call Logs

...

Anchor
_Toc8740049
_Toc8740049
Expressway Call Logs

...

Anchor
_Toc8740050
_Toc8740050
CDR

...

...

Anchor
_Toc8740051
_Toc8740051
DNA Visualizer

  • Select interface

  • Source number

  • Destination number

  • CSS

...

Anchor
_Toc535320719
_Toc535320719
Anchor
_Toc8740052
_Toc8740052
Yarndoor

Anchor
_Toc535320720
_Toc535320720
Anchor
_Toc8740053
_Toc8740053
Yarndoor Authentication and Setup

  1. Create Authentication Database

...

  1. Adjust roles as required restricting to only the required applications

  2. Create Access Policy

...

    1. Login via Email (UPN) – adjust regex's to restrict to specific domains and email format

Example email validation ([a-z0-9!#$%&'/=?`{|}](?:\.[a-z0-9!#$%&'/=?`{|}])@(?:[a-z0-9](?:[a-z0-9-][a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)
Base DN = domain in LDAP syntax
Username field = userPrincipalName

    1. Login via username – adjust regex's to block domain\user and email address formats

Example (^[A-Za-z0-9](?:[ _-][A-Za-z0-9])*$)
Base DN = domain in LDAP syntax
Username field = userPrincipalName

  1. Start The Engineer App and Yarndoor App and set Access Policy

You may wish to directly expose Yarndoor and not use proxy for end users to do so
Set Host to 0.0.0.0 (or IP Address of node)

  1. Add both engineer app and Yarndoor app to proxy service

...

Anchor
_Toc535320721
_Toc535320721
Anchor
_Toc8740054
_Toc8740054
Yarndoor Branding

  1. Select Branding in the administration app

...

  1. Install Branding File

...

  1. Verify that the branding is available

...

  1. Navigate to the Yarndoor service that you wish to brand and apply the branding

...

Anchor
_Toc535320722
_Toc535320722
Anchor
_Toc8740055
_Toc8740055
Admin Access Setup

  1. Navigate to the Engineer App (ensure it was added to proxy)

...

  1. Add a feature

...

  1. Select Administration Access Tracking

...

  1. Add the required interface and set default allowed time. Note each CUCM/EXPW/UCXN will require to be added as an interface


Note that the role for admin users is defined on a per interface basis

If a CUCDM8 interface is added Yarnman can extract Customers/Hardware Groups and UC systems including IP addresses and credentials

  1. Select User Portal

...

  1. Add the required feature(s)

...

Anchor
_Toc513211417
_Toc513211417
Anchor
_Toc535320723
_Toc535320723
Anchor
_Toc8740056
_Toc8740056
Using Admin Access


  1. Select Yarndoor (admin access) or browse directly

...

  1. Select the required customer and interface then press get access

...

  1. One time credentials are created

    1. Open interface opens new tab to target system

    2. Release access removes account

      1. Once account is removed audit logs are available for download



Anchor
_GoBack
_GoBack