SONAR User manual
Contents
1. SONAR User manual 02 2015 Table of Contents Table of Contents 1 2 1 2 2 2 3 2 4 2 9 2 6 3 1 3 2 3 3 3 4 3 5 3 6 Organization registration Forgotten password The SONAR portal Roles amp permissions 2 1 1 User 2 1 2 Admin Reports menu 2 2 1 Completed reports 2 2 2 Download a single report 2 2 3 Download multiple reports 2 2 4 Delete a single report 2 2 5 Delete multiple reports 2 2 6 Change a saved report name or reference information 2 2 7 Searching for a report by keyword 2 2 8 Filtering a column by a keyword Support menu 2 3 1 Downloads 2 3 2 Getting Started 2 3 3 Buy Licenses 2 3 4 Support Tickets Administration menu 2 4 1 My Profile 2 4 2 User setup Help menu 2 5 1 Help 2 5 2 About Toolbar area 2 6 1 Licensing 2 6 2 Sign Out SONAR client What is the SONAR client Client installation requirements Downloading the latest client Installing the client Updating the client Generating a report GOOD CON N NN N N OO A N SONAR User manual 2 02 2015 You can find the latest documentation for this product here http sonar raas com Document Feedback Xtravirt welcomes any feedback for documentation improvement Comments should be submitted to support sonar raas com Technical Support Technical support is provided where there is a valid subscription under the terms of the End User License Agreement Product feedback and fault identification is2. A member of the SONAR support team will review your ticket as soon as possible Log a support ticket if you find a bug in the SONAR system want to request a feature or just need general assistance please log a support ticket using the form below Organisation Xtravirt User paul davey xtravirt com Type Bug Summary Descriptio Attach file create ticket 2 4 Administration menu The Administration menu allows users to the SONAR portal to amend their account details If you are a member of the Admin role you can also manage user accounts for your organization from here 24 1 My Profile My Profile allows you to manage your account configuration update account information and reset your password Change Profile v You have previously agreed to our terms and conditions if you would ike to review them click here Updating account details Update your first name last name email address and country location Click save If the details have been updated successfully you will receive a confirmation message at the top of the screen SONAR User manual i Change Profile Success details have been successfully updated ua s i You have ceeviausty agreed to ow berms and conctiions you would Eke to review them cl alk here Changing password Click the change password link Enter your new password and then again for verification Click save to update your password cancel password change S Yo
3. list to expand it and see the answer licensing anonuserghexampieorg com 2 Help general porta client How do I Questions Answers How do generate a report Reports Nulla sollicitudin justo nec eleifend lobortis Morbi sed turpis erat Duis sed __ _ ____ vehicula ligula Vivamus suscipit mi sed risus tempus tincidunt Praesent egestas How do add users to my organisation How do delete a report 2 5 2 About ullamcorper tortor malesuada hendreri justo tincidunt ou Vivamus feugiat turpis a clit sagittis id venenatis nibh amare Proin id tempus nisl nec iaculis elit The About dialog provides some basic information about the platform and your organization account Your organization ID is found here which is required when purchasing licenses and upgrades Administrators of your organization are also listed here 02 2015 SONAR User manual 15 2 6 Toolbar area The toolbar area provides quick access to sign out of the platform check licensing and obtain your Organization ID 2 6 1 Licensing Clicking the licensing button will provide you a dialog that lists your organization s licenses License the type of license for example vSphere Current licenses the number of licenses that you have purchased Expiry the expiry date of the license licensing Your organisation does not currently hold any active licences A 2 6 2 Sign Out Clicking Sign Out will
4. 1 General User The User role is the common role group that your users should belong to It allows users to do the following Login to the portal Manage their own user account Ability to download the SONAR client and associated collateral Access the FAQ amp raise support tickets Collect data with the SONAR Client and upload to the SONAR portal Generate reports from the SONAR client 2 1 2 General Admin The Administrator account has the same permissions as the User role as well as additionally being able to do the following Manage organization user accounts add delete disable Note By default the first user account for an organization is a member of the General Admin role group 2 2 Reports menu The Reports menu contains a single entry the Reports page It is comprised of 3 views each accessed by clicking the relevant link above the table ExampleOrg Repo rts last update 22 77 completed reports jobs processing failed jobs 64 adaptor vCenter vSphere report type vSphere health assessment v1 1 vSphere summary health assessment v1 1 dacx anonuserttexemnplearg com 26 02 2015 20 28 45 This is my first report 2 2 1 Completed reports All reports that have been successfully generated can be found under the completed reports view You can select reports to edit their reference delete or download them 02 2015 SONAR User manual 7 22 2 Download a single report BSONNR Find the rep
5. 6 Click the next arrow at the bottom of the screen 02 2015 SONAR User manual 21 suNar 7 An automated discovery of your infrastructure will then begin Once complete the wizard will automatically progress performing discovery Tr in ht eee Tend al ile Pes hese ibe paben as this man baan Carre depenie ice pe one 8 The specific data needed to generate your report will now be collected When this step is complete the wizard will automatically progress collecting data he wizard vel suocmertica sy progress Piense be pris m this mey tebe fev depending upon you ocnnection speed 02 2015 SONAR User manual 22 02 2015 suNar 9 Enter your SONAR portal credentials to authenticate to enable the data to be automatically uploaded Click the Upload button The wizard will automatically progress when the data upload has completed 10 Once the upload has finished the SONAR portal will automatically generate the report You can check progress by logging into the portal and download once complete Clert complete ra uploaded Your reports he sesdable on the SOMAR portal shorily SONAR User manual 23
6. dit menu allows you to review activities on the portal Select a date range and a choice of audit types then click search Any results found will be displayed Note only users with a role of General Admin can access the Audit page e SONAN xi 8 nttos sonartest virtiab co uk 8443 adminkeration Viewfuadt E Mel Visted gt Calling Sl ted Supgeslod Silas Wat Sio Gallery Ned Volume Sha ExampleOrg Administration Help Commmrily Epe Cloud e B coga lappie Ei Facsbook Twila Migala Yt C Neas D Popul licensing sign out anonusen exampleorg com 2 arot ft eg Audit search filters results start date 26 02 2015 00 00 end date 26 02 2015 23 59 user email 2 5 Help menu audit types 7 I organisation administraition W reports tit access reports access system statistics reports delete multiple reports delete report dawnisaded repart edit report report deleted report downloaded request download reports I af support i IE system access je T E system administration OOOOO0Oo0O0O88 search The Help menu provides access to the portal online help system as well as the About information dialog 2 5 1 Help The Help menu provides access to the portals online help system To search the online Help system enter your search term and press enter Click on a question in ExampleOrg Support Administration Help the
7. e rea free country United Kingdom role Generel Admin account enabled email notifications Disabling a user account Select the user you wish to disable Click disable to save the change Current Users email address first name ast name ocaton role enabled email notfications ry anonuser exampleorg anon user United Kingdam General Admin true true 02 2015 SONAR User manual 13 suNar Deleting a user account Select the user you wish to delete Click delete A confirmation dialogue will appear Click delete to confirm Current Users email address first name ast name ocaton role enabled email notifications 2 anonuser exampleorg anon user United Kingdam General Admin true tue Configuring email notifications for a user account Select a user and click edit Tick the email notifications checkbox to enable notifications Clear it to disable notifications Click save to confirm the change Edit User email fred exariplearg com first name frad country United Kingdom role General Admin account enabled email notifications Configuring additional Admin users 1 Click add user Complete the form Ensure the role is set to General Admin Click save Add User email fred exampleorg com first name Cc country United Kingdom role General Admin account enabled email notifications 02 2015 SONAR User manual 14 Audit svuNnNar The Au
8. e reports Find the reports that you wish to delete Select multiple reports by ticking the checkboxes Click delete A confirmation dialogue will appear Click delete to confirm CS VW ExampleOrg licansing sign out anonuser exampleorg com Ti N Support Reports last update 2031 12 2 0 0 completed reports v jobs processing amp failed jobs x adaptor report type report name requester created date reference adaptor vCenter vSphere report type vSphere health assessment v1 7 vSphere summary health assessment v1 1 docx anonuser exampisorg com 26 02 2015 20 28 45 This is my first report vSphere health assessment vI docx anonuserGexampleoy com 26 02 2015 20 28 45 This Js my first report 2 2 6 Change a saved report name or reference information Select the report you wish to edit the name or reference information by selecting the checkbox Click the edit button Edit the report name and reference information then click save ExampleOrg Support Reports T lest updere 20 31 12 2 0 0 completed reports Vy jobs processing failed jobs 63 adaptor f report type 7 s t nam t created date reference adaptor vCenter vSphere report type vSphere health assessment v1 1 vSphere summary health assessment v1 1 docx anonuser exampleorg com gorm 2 2 7 Searching for a report by keyword Select the search box located above the table and enter the word or characters you want to
9. entered on the registration form check your email to activate it 5 Click the link provided in the email to successfully activate the organization account This will enable login to the SONAR portal 1 1 Forgotten password If you have forgotten your password you can request a password reset Complete the following steps to reset a password 1 On the login screen of the SONAR portal click the Forgotten your password link 02 2015 SONAR User manual suNar 2 Enter your organization name and email address Click reset password 3 A confirmation message will be displayed Check your email for an automated message from the SONAR platform af Your request has been recieved Please check your email for further instructions 4 When the email arrives click the link to reset your password a browser window will open Password Change Request fou have mquesied io reset your password for SOMAR Please click fire to complete your password maal xirayirt 5 Enter your email address and a new password Click the save button You will then be redirected to the portal login page organisation organisation name Change Password Please reset you password by completing the form below Email password password 02 2015 SONAR User manual 6 OASINAR 2 The SONAR portal 2 1 Roles amp permissions The SONAR portal supports two types of roles General User and General Admin 2 1
10. le origin Downloaded from the Internet Y Show details No Change when these notifications appear 3 On the Welcome page click Next 34 Sonar Client Setup mmj Welcome to the Sonar Client Setup Wizard The Setup Wizard will install Sonar Client BETA on your computer Click Next to continue or Cancel to exit the Setup Wizard lt Back Next gt 4 Change the installation location or accept the default location recommended Click Next to continue E E E Sonar Client Setup Select Installation Folder This is the folder where Sonar Client BETA will be installed To install in this folder dick Next To install to a different folder enter it below or dick Browse Folder C Program Files x86 Xtravirt Limited Sonar Client Advanced Installer 02 2015 SONAR User manual 18 s uv Ark 5 Click Install 1 Sonar Client Setup Ready to Install The Setup Wizard is ready to begin the Sonar Client installation Click Install to begin the installation If you want to review or change any of your installation settings dick Back Click Cancel to exit the wizard Advanced Installer 6 Click Finish to complete the installation i Sonar Client Setup mie Completing the Sonar Client Setup Wizard Click the Finish button to exit the Setup Wizard 3 5 Updating the client Periodically new versions of the SONAR Client are released I
11. ort you wish to download Select the report using the checkbox Click the download button 2 2 3 Reports 2 completed reports Vy adaptor vCenter vSphere vSphere summary health assessment v1 1 docx 0 jobs processing report type vSphere health assessment v1 1 anonuserQexampileorg com T lest updene 20 35 12 0 failed jobs 63 This is my first report Download multiple reports Find the reports you wish to download Select each report using the checkbox Click download The selected reports will be automatically put into a zip file and you will be prompted to download 2 2 4 Reports 2 completed reports adaptor vGenter vSphere vSphere health assessment vT 1 docx 0 jobs processing requester created date report type vSphere health assessment v1 1 anonuserGexam pmeorg com D last update 2031 12 0 failed jobs 624 This is my first report This js my first report Delete a single report Select the report you wish to delete by ticking the checkbox box next to the report Click delete A confirmation dialogue will appear Click delete to confirm 02 2015 Delete Selected Reports You have selected 1 report lo delete any reports contained within this selection will be removed from the platform and will not be recoverable ara you sure you want to continua ccs EE SONAR User manual 8 svuNar 2 2 5 Delete multipl
12. search then press enter The list will auto filter to display the results as well as highlighting instances of your search term within the results To clear the search term click the x icon in the search box ExampleOrg Reparts Support Administration Help Reports last undeta 70 35 53 2 0 0 completed reports Se Jobs processing failed jobs 63 adaptor t report type 4 anonuser x report name requester created date reference adaptor yOenter vSphere gt report type vSphere health assessment v1 1 vSphere summary health assessment v1 1 docx SU iS exampleorg com 26 02 2015 20 28 45 This is my first report vSphere hesith assessment vJ 1 docx FRENTE ampeg com 26 02 2015 20 28 45 This is my first report 02 2015 SONAR User manual 9 2 2 8 Filtering a column by a keyword Enter the keyword within the column of the table you wish to filter press enter The list will auto filter to display the results To clear the column filter delete the text in the column filter box and press enter ExampleOrg Reports last undete 20 35 53 completed reports jobs processing failed jobs 62 adaptor Center vSphere report type vSphere health assessment v1 1 vSphere summery health assessment v1 1 docx snonuser exampleorg com 26 02 2015 20 28 45 This le my first report Jobs Processing The jobs processing view accessed by clicking on the jobs processing link lists all report processing jobs currentl
13. sign you out of the SONAR portal and return you to the login screen 02 2015 SONAR User manual 16 3 3 1 SONAR client What is the SONAR client The SONAR client is used to select and generate SONAR reports including configuring connections to infrastructure components discovering and collecting data and uploading to the SONAR platform for analytics and processing 3 2 Client installation requirements The following are required to successfully install and use the SONAR client 3 3 Physical or virtual machine Windows 7 Windows 8 Windows Server 2008 or Microsoft Server 2012 4GB Ram 1 Dual Core CPU Minimum 8GB disk space more if you have a large infrastructure Minimum supported screen resolution 1280 x 800 Network Connectivity Direct internet connection Microsoft Net Framework 4 5 SP1 Downloading the latest client Download the latest client from the Downloads page located in the Support menu of the portal Click the link at the top of the Downloads page 3 4 1 2 02 2015 Downloads Suen serene dick here to download Installing the client Extract the SONAR client zip file Double click the exe file to start the installation Click Yes to start the installation SONAR User manual 17 suvuNar E User Account Control gt Do you want to allow the following program to make changes to this computer Program name Sonar Client BETA Verified publisher Xtravirt Limited Fi
14. t can be updated using the following two methods 02 2015 Method 1 Automated check at start up If connected to the Internet the SONAR client will check for updates at start up If any are available you will be prompted to download and install Method 2 Manual check To manually check for a newer version of the client sign in to the SONAR portal If a newer version exists download and follow the installation previous instructions to update to the latest version SONAR User manual 19 3 6 Generating a report 1 Launch the SONAR client If you have no existing connections you will be prompted to create one Click Ok 2 Click the Enter a name for this connection cell Type a name for the connection Select the Connection type Select the vCenter vSphere connection type Press Enter to create the connection then complete the connection details BT BLE pp 3 Click the next arrow at the bottom of the screen 02 2015 SONAR User manual 20 svuNar 4 When prompted click Yes to save the connection 5 Select the report you wish to generate If you wish to enter a reference for your report you can select a cell in the custom report references and type a brief note This will appear on the portal in the Reports page as a field next to the completed report Wghere summary hes egth Antmen for vioher brand raver eruranmen i Cee oy Chre kia ies B Cmap Chirk Oe EE i hik EUa ara ta amp pihon oles cm al
15. u have previously agreed to our terms and conditions if you would like to review them click here Configuring email notifications If you wish to receive email notifications when a report has been generated ensure that the email notifications checkbox box is ticked Changing your profile picture You can change your profile picture that appears on the SONAR portal To do so you require a profile picture that has been created with the free Gravatar service http gravatar com change profile picture with Gravatar 2 4 2 User setup Note you will only see this menu item displayed if your account is configured as an Admin for your organization 02 2015 SONAR User manual 12 svuNnNar Adding new users You can add additional users to your organization Users can be members of either the User role or the Admin role Click the add user button Complete the Add User form Ensure the General User role is selected Click save The user will be emailed by the SONAR platform notifying that an account for them has been created with instructions for how to use Edit User email fred exampleorg com first name fred last name hands country United Kingdom role General User vf account enabled email notifications Editing a user Click the user you wish to edit Click the edit button When you have completed your changes click the save button Add User email fred exampleorg com first nam
16. welcomed and comments should be submitted to support sonar raas com 2015 Xtravirt Ltd All rights reserved The Xtravirt logo and design are registered trademarks of Xtravirt Ltd All other marks and names mentioned herein may be trademarks of their respective companies Warranty to the maximum extent permitted by applicable mandatory law Xtravirt and its licensors provide the software without any warranties of any kind express implied statutory or in any other provision of the EULA or communication with you and Xtravirt and its licensors specifically disclaim any implied warranties of merchantability fitness for a particular purpose and non infringement SONAR User manual 3 svuNar 1 Organization registration Before you can use SONAR you need to register your organization with the SONAR portal Registration will allow you to download the SONAR client collect information and generate reports Note When you register your organization you are automatically added to the Admin role group For more information refer to the Roles amp permissions section in Chapter 4 of this document 1 Navigate to the SONAR portal at the following URL https portal sonar raas com Click the Register here link 2 Complete the registration form Once completed click Register Please note all fields are required 02 2015 SONAR User manual 4 svuNar 4 Once registered an activation email will be sent to the email address
17. y being run for your organization When data is collected and uploaded to the SONAR platform the platform service picks up the job and lists it here Once the job is completed and the report has been generated the count will increase on the completed reports view Failed Jobs Any job being run by the service that fails to successfully generate a report will be listed here 2 3 Support menu The Support menu provides access to software downloads and both client and platform support facilities 2 3 1 Downloads The downloads page contains various collateral items including the SONAR client and user manual The link at the top of the page will always download the latest client Downloads inaina Download the latest version of the SONAR client dick hare to download 2 3 2 Getting Started Displays the Getting Started page which appears when you log into the portal 2 3 3 Buy Licenses This link will send you to the online SONAR shop located on the sonar raas com website From there you can purchase licenses and add on features 2 3 4 Support Tickets 02 2015 SONAR User manual 10 02 2015 If you need to report a bug request a feature or have any general questions you can raise a support ticket using the Log a support ticket online form Complete the form with as much information as possible If possible attach a screenshot or any other assets that may help the support team better understand your request Click create ticket
Download Pdf Manuals
Related Search