ImcSdk 0.9.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +12 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/.yardopts +7 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +4 -0
- data/ImcSdk.gemspec +43 -0
- data/LICENSE +201 -0
- data/Makefile +9 -0
- data/README.md +79 -0
- data/Rakefile +15 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/docs/ImcHandle.html +2900 -0
- data/docs/_index.html +109 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +492 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +147 -0
- data/docs/js/app.js +248 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +619 -0
- data/docs/top-level-namespace.html +10218 -0
- data/lib/ImcSdk.rb +395 -0
- data/lib/ImcSdk/apis/admin/ipmi.rb +99 -0
- data/lib/ImcSdk/apis/admin/ldap.rb +304 -0
- data/lib/ImcSdk/apis/admin/ntp.rb +202 -0
- data/lib/ImcSdk/apis/admin/user.rb +221 -0
- data/lib/ImcSdk/apis/server/bios.rb +311 -0
- data/lib/ImcSdk/apis/server/power.rb +219 -0
- data/lib/ImcSdk/apis/server/remotepresence.rb +170 -0
- data/lib/ImcSdk/apis/server/serveractions.rb +382 -0
- data/lib/ImcSdk/apis/server/storage.rb +438 -0
- data/lib/ImcSdk/apis/utils.rb +55 -0
- data/lib/ImcSdk/imcbasetype.rb +121 -0
- data/lib/ImcSdk/imcconstants.rb +1351 -0
- data/lib/ImcSdk/imccore.rb +220 -0
- data/lib/ImcSdk/imccoremeta.rb +271 -0
- data/lib/ImcSdk/imccoreutils.rb +441 -0
- data/lib/ImcSdk/imcdriver.rb +187 -0
- data/lib/ImcSdk/imcexception.rb +86 -0
- data/lib/ImcSdk/imcfiltertype.rb +228 -0
- data/lib/ImcSdk/imcgenutils.rb +29 -0
- data/lib/ImcSdk/imcmeta.rb +975 -0
- data/lib/ImcSdk/imcmethod.rb +182 -0
- data/lib/ImcSdk/imcmethodfactory.rb +190 -0
- data/lib/ImcSdk/imcmo.rb +669 -0
- data/lib/ImcSdk/imcsession.rb +549 -0
- data/lib/ImcSdk/imcxmlcodec.rb +94 -0
- data/lib/ImcSdk/methodmeta/AaaGetComputeAuthTokensMeta.rb +16 -0
- data/lib/ImcSdk/methodmeta/AaaKeepAliveMeta.rb +14 -0
- data/lib/ImcSdk/methodmeta/AaaLoginMeta.rb +36 -0
- data/lib/ImcSdk/methodmeta/AaaLogoutMeta.rb +18 -0
- data/lib/ImcSdk/methodmeta/AaaRefreshMeta.rb +36 -0
- data/lib/ImcSdk/methodmeta/ConfigConfMoMeta.rb +22 -0
- data/lib/ImcSdk/methodmeta/ConfigConfMosMeta.rb +20 -0
- data/lib/ImcSdk/methodmeta/ConfigResolveChildrenMeta.rb +24 -0
- data/lib/ImcSdk/methodmeta/ConfigResolveClassMeta.rb +20 -0
- data/lib/ImcSdk/methodmeta/ConfigResolveDnMeta.rb +20 -0
- data/lib/ImcSdk/methodmeta/ConfigResolveParentMeta.rb +20 -0
- data/lib/ImcSdk/methodmeta/EventSubscribeMeta.rb +14 -0
- data/lib/ImcSdk/methodmeta/EventUnsubscribeMeta.rb +14 -0
- data/lib/ImcSdk/mometa/aaa/AaaLdap.rb +269 -0
- data/lib/ImcSdk/mometa/aaa/AaaLdapRoleGroup.rb +122 -0
- data/lib/ImcSdk/mometa/aaa/AaaSession.rb +123 -0
- data/lib/ImcSdk/mometa/aaa/AaaUser.rb +130 -0
- data/lib/ImcSdk/mometa/aaa/AaaUserEp.rb +88 -0
- data/lib/ImcSdk/mometa/aaa/AaaUserPasswordExpiration.rb +118 -0
- data/lib/ImcSdk/mometa/aaa/AaaUserPolicy.rb +100 -0
- data/lib/ImcSdk/mometa/activate/ActivatePIDCatalog.rb +101 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorCfgBackup.rb +143 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorCfgImporter.rb +143 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorConnectorInfo.rb +97 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthCompQueueProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthGenProfile.rb +158 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthISCSIProfile.rb +261 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthInterruptProfile.rb +116 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthOffloadProfile.rb +112 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthRdmaProfile.rb +106 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthRecvQueueProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthUSNICProfile.rb +167 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorEthWorkQueueProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorExtEthIf.rb +154 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorExtIpV6RssHashProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcBootTable.rb +106 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcCdbWorkQueueProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcErrorRecoveryProfile.rb +130 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcGenProfile.rb +133 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcInterruptProfile.rb +96 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcPersistentBindings.rb +118 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcPortFLogiProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcPortPLogiProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcPortProfile.rb +106 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcRecvQueueProfile.rb +94 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorFcWorkQueueProfile.rb +94 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorGenProfile.rb +166 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorHostEthIf.rb +163 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorHostFcIf.rb +148 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorIpV4RssHashProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorIpV6RssHashProfile.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorLinkTraining.rb +79 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorPortProfiles.rb +100 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorRssProfile.rb +94 -0
- data/lib/ImcSdk/mometa/adaptor/AdaptorUnit.rb +155 -0
- data/lib/ImcSdk/mometa/advanced/AdvancedPowerProfile.rb +140 -0
- data/lib/ImcSdk/mometa/auto/AutoPowerProfile.rb +117 -0
- data/lib/ImcSdk/mometa/bios/BiosBOT.rb +88 -0
- data/lib/ImcSdk/mometa/bios/BiosBootDev.rb +114 -0
- data/lib/ImcSdk/mometa/bios/BiosBootDevGrp.rb +112 -0
- data/lib/ImcSdk/mometa/bios/BiosBootDevPrecision.rb +152 -0
- data/lib/ImcSdk/mometa/bios/BiosBootMode.rb +96 -0
- data/lib/ImcSdk/mometa/bios/BiosPassword.rb +73 -0
- data/lib/ImcSdk/mometa/bios/BiosPlatformDefaults.rb +88 -0
- data/lib/ImcSdk/mometa/bios/BiosProfile.rb +139 -0
- data/lib/ImcSdk/mometa/bios/BiosProfileManagement.rb +106 -0
- data/lib/ImcSdk/mometa/bios/BiosProfileToken.rb +106 -0
- data/lib/ImcSdk/mometa/bios/BiosSettings.rb +88 -0
- data/lib/ImcSdk/mometa/bios/BiosUnit.rb +106 -0
- data/lib/ImcSdk/mometa/bios/BiosVfASPMSupport.rb +97 -0
- data/lib/ImcSdk/mometa/bios/BiosVfAdjacentCacheLinePrefetch.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfAltitude.rb +99 -0
- data/lib/ImcSdk/mometa/bios/BiosVfAssertNMIOnPERR.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfAssertNMIOnSERR.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfAutonumousCstateEnable.rb +81 -0
- data/lib/ImcSdk/mometa/bios/BiosVfBootOptionRetry.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCDNEnable.rb +92 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCDNSupport.rb +96 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCPUEnergyPerformance.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCPUFrequencyFloor.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCPUPerformance.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCPUPowerManagement.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCkeLowPolicy.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCmciEnable.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfConsoleRedirection.rb +162 -0
- data/lib/ImcSdk/mometa/bios/BiosVfCoreMultiProcessing.rb +118 -0
- data/lib/ImcSdk/mometa/bios/BiosVfDCUPrefetch.rb +109 -0
- data/lib/ImcSdk/mometa/bios/BiosVfDRAMClockThrottling.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfDemandScrub.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfDirectCacheAccess.rb +100 -0
- data/lib/ImcSdk/mometa/bios/BiosVfDramRefreshRate.rb +99 -0
- data/lib/ImcSdk/mometa/bios/BiosVfEnhancedIntelSpeedStepTech.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfExecuteDisableBit.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfExtendedAPIC.rb +92 -0
- data/lib/ImcSdk/mometa/bios/BiosVfFRB2Enable.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfHWPMEnable.rb +80 -0
- data/lib/ImcSdk/mometa/bios/BiosVfHardwarePrefetch.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfIOHResource.rb +99 -0
- data/lib/ImcSdk/mometa/bios/BiosVfIntelHyperThreadingTech.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfIntelTurboBoostTech.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfIntelVTForDirectedIO.rb +142 -0
- data/lib/ImcSdk/mometa/bios/BiosVfIntelVirtualizationTechnology.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfLOMPortOptionROM.rb +150 -0
- data/lib/ImcSdk/mometa/bios/BiosVfLegacyUSBSupport.rb +100 -0
- data/lib/ImcSdk/mometa/bios/BiosVfLvDIMMSupport.rb +97 -0
- data/lib/ImcSdk/mometa/bios/BiosVfMMCFGBase.rb +99 -0
- data/lib/ImcSdk/mometa/bios/BiosVfMemoryInterleave.rb +126 -0
- data/lib/ImcSdk/mometa/bios/BiosVfMemoryMappedIOAbove4GB.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfMirroringMode.rb +96 -0
- data/lib/ImcSdk/mometa/bios/BiosVfNUMAOptimized.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfOSBootWatchdogTimer.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfOSBootWatchdogTimerPolicy.rb +97 -0
- data/lib/ImcSdk/mometa/bios/BiosVfOSBootWatchdogTimerTimeout.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfOnboardNIC.rb +109 -0
- data/lib/ImcSdk/mometa/bios/BiosVfOnboardStorage.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfOnboardStorageSWStack.rb +90 -0
- data/lib/ImcSdk/mometa/bios/BiosVfOutOfBandMgmtPort.rb +92 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPCIOptionROMs.rb +100 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPCISlotOptionROMEnable.rb +726 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPCIeSSDHotPlugSupport.rb +81 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPOSTErrorPause.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPStateCoordType.rb +97 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPackageCStateLimit.rb +105 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPatrolScrub.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPatrolScrubDuration.rb +94 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPchUsb30Mode.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPciRomClp.rb +92 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPowerOnPasswordSupport.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfProcessorC1E.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfProcessorC3Report.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfProcessorC6Report.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfProcessorCState.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfPwrPerfTuning.rb +90 -0
- data/lib/ImcSdk/mometa/bios/BiosVfQPIConfig.rb +99 -0
- data/lib/ImcSdk/mometa/bios/BiosVfQpiSnoopMode.rb +94 -0
- data/lib/ImcSdk/mometa/bios/BiosVfResumeOnACPowerLoss.rb +111 -0
- data/lib/ImcSdk/mometa/bios/BiosVfSataModeSelect.rb +97 -0
- data/lib/ImcSdk/mometa/bios/BiosVfSelectMemoryRASConfiguration.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfSerialPortAEnable.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfSparingMode.rb +96 -0
- data/lib/ImcSdk/mometa/bios/BiosVfSrIov.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfTPMSupport.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfUCSMBootOrderRuleControl.rb +96 -0
- data/lib/ImcSdk/mometa/bios/BiosVfUSBBootConfig.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfUSBEmulation.rb +98 -0
- data/lib/ImcSdk/mometa/bios/BiosVfUSBPortsConfig.rb +164 -0
- data/lib/ImcSdk/mometa/bios/BiosVfVgaPriority.rb +97 -0
- data/lib/ImcSdk/mometa/bios/BiosVfWorkLoadConfig.rb +90 -0
- data/lib/ImcSdk/mometa/bmc/BmcResetReason.rb +77 -0
- data/lib/ImcSdk/mometa/certificate/CertificateManagement.rb +94 -0
- data/lib/ImcSdk/mometa/chassis/ChassisPIDCatalog.rb +77 -0
- data/lib/ImcSdk/mometa/chassis/ChassisPowerBudget.rb +110 -0
- data/lib/ImcSdk/mometa/chassis/ChassisPowerMonitor.rb +93 -0
- data/lib/ImcSdk/mometa/chassis/ChassisPowerUtilization.rb +77 -0
- data/lib/ImcSdk/mometa/comm/CommEpIpmiLan.rb +87 -0
- data/lib/ImcSdk/mometa/comm/CommHttp.rb +149 -0
- data/lib/ImcSdk/mometa/comm/CommHttps.rb +141 -0
- data/lib/ImcSdk/mometa/comm/CommIpmiLan.rb +108 -0
- data/lib/ImcSdk/mometa/comm/CommKvm.rb +124 -0
- data/lib/ImcSdk/mometa/comm/CommNtpProvider.rb +130 -0
- data/lib/ImcSdk/mometa/comm/CommRedfish.rb +86 -0
- data/lib/ImcSdk/mometa/comm/CommSavedVMediaMap.rb +148 -0
- data/lib/ImcSdk/mometa/comm/CommSnmp.rb +169 -0
- data/lib/ImcSdk/mometa/comm/CommSnmpTrap.rb +149 -0
- data/lib/ImcSdk/mometa/comm/CommSnmpUser.rb +147 -0
- data/lib/ImcSdk/mometa/comm/CommSsh.rb +141 -0
- data/lib/ImcSdk/mometa/comm/CommSvcEp.rb +88 -0
- data/lib/ImcSdk/mometa/comm/CommSvcRack.rb +73 -0
- data/lib/ImcSdk/mometa/comm/CommSyslog.rb +151 -0
- data/lib/ImcSdk/mometa/comm/CommSyslogClient.rb +123 -0
- data/lib/ImcSdk/mometa/comm/CommVMedia.rb +122 -0
- data/lib/ImcSdk/mometa/comm/CommVMediaMap.rb +153 -0
- data/lib/ImcSdk/mometa/compute/ComputeBoard.rb +178 -0
- data/lib/ImcSdk/mometa/compute/ComputeMbPowerStats.rb +112 -0
- data/lib/ImcSdk/mometa/compute/ComputeRackUnit.rb +206 -0
- data/lib/ImcSdk/mometa/compute/ComputeRackUnitMbTempStats.rb +101 -0
- data/lib/ImcSdk/mometa/compute/ComputeServerNode.rb +192 -0
- data/lib/ImcSdk/mometa/compute/ComputeServerNodeMbTempStats.rb +101 -0
- data/lib/ImcSdk/mometa/compute/ComputeServerRef.rb +81 -0
- data/lib/ImcSdk/mometa/compute/ComputeSharedIOMbPowerStats.rb +89 -0
- data/lib/ImcSdk/mometa/compute/ComputeSharedIOMbTempStats.rb +99 -0
- data/lib/ImcSdk/mometa/current/CurrentCertificate.rb +178 -0
- data/lib/ImcSdk/mometa/custom/CustomPowerProfile.rb +103 -0
- data/lib/ImcSdk/mometa/download/DownloadClientCertificate.rb +106 -0
- data/lib/ImcSdk/mometa/download/DownloadClientPrivateKey.rb +106 -0
- data/lib/ImcSdk/mometa/download/DownloadLdapCACertificate.rb +135 -0
- data/lib/ImcSdk/mometa/download/DownloadRootCACertificate.rb +106 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentChassis.rb +93 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentChassisLocatorLed.rb +106 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentFan.rb +223 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentFanModule.rb +217 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentIndicatorLed.rb +122 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentLocatorLed.rb +131 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentPsu.rb +235 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentPsuColdRedundancy.rb +77 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentPsuFan.rb +186 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentSharedIOModule.rb +125 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentSystemIOController.rb +87 -0
- data/lib/ImcSdk/mometa/equipment/EquipmentTpm.rb +164 -0
- data/lib/ImcSdk/mometa/error/Error.rb +98 -0
- data/lib/ImcSdk/mometa/event/EventManagement.rb +100 -0
- data/lib/ImcSdk/mometa/export/ExportClientCertificate.rb +106 -0
- data/lib/ImcSdk/mometa/export/ExportClientPrivateKey.rb +106 -0
- data/lib/ImcSdk/mometa/export/ExportLdapCACertificate.rb +135 -0
- data/lib/ImcSdk/mometa/export/ExportRootCACertificate.rb +106 -0
- data/lib/ImcSdk/mometa/fan/FanPolicy.rb +89 -0
- data/lib/ImcSdk/mometa/fault/FaultInst.rb +238 -0
- data/lib/ImcSdk/mometa/firmware/FirmwareBootDefinition.rb +101 -0
- data/lib/ImcSdk/mometa/firmware/FirmwareBootUnit.rb +159 -0
- data/lib/ImcSdk/mometa/firmware/FirmwareRunning.rb +124 -0
- data/lib/ImcSdk/mometa/firmware/FirmwareUpdatable.rb +197 -0
- data/lib/ImcSdk/mometa/generate/GenerateCertificateSigningRequest.rb +435 -0
- data/lib/ImcSdk/mometa/generate/GenerateRandomPassword.rb +94 -0
- data/lib/ImcSdk/mometa/generated/GeneratedStorageControllerKeyId.rb +77 -0
- data/lib/ImcSdk/mometa/huu/HuuController.rb +94 -0
- data/lib/ImcSdk/mometa/huu/HuuFirmwareCatalog.rb +100 -0
- data/lib/ImcSdk/mometa/huu/HuuFirmwareCatalogComponent.rb +106 -0
- data/lib/ImcSdk/mometa/huu/HuuFirmwareComponent.rb +154 -0
- data/lib/ImcSdk/mometa/huu/HuuFirmwareRunning.rb +106 -0
- data/lib/ImcSdk/mometa/huu/HuuFirmwareUpdateCancel.rb +95 -0
- data/lib/ImcSdk/mometa/huu/HuuFirmwareUpdateStatus.rb +118 -0
- data/lib/ImcSdk/mometa/huu/HuuFirmwareUpdater.rb +179 -0
- data/lib/ImcSdk/mometa/huu/HuuUpdateComponentStatus.rb +178 -0
- data/lib/ImcSdk/mometa/io/IoExpander.rb +104 -0
- data/lib/ImcSdk/mometa/iod/IodController.rb +94 -0
- data/lib/ImcSdk/mometa/iod/IodSnapshotCancel.rb +101 -0
- data/lib/ImcSdk/mometa/iod/IodSnapshotStart.rb +192 -0
- data/lib/ImcSdk/mometa/iod/IodSnapshotStatus.rb +148 -0
- data/lib/ImcSdk/mometa/ip/IpBlocking.rb +118 -0
- data/lib/ImcSdk/mometa/ip/IpFiltering.rb +128 -0
- data/lib/ImcSdk/mometa/kmip/KmipManagement.rb +95 -0
- data/lib/ImcSdk/mometa/kmip/KmipServer.rb +98 -0
- data/lib/ImcSdk/mometa/kmip/KmipServerLogin.rb +89 -0
- data/lib/ImcSdk/mometa/ldap/LdapCACertificate.rb +107 -0
- data/lib/ImcSdk/mometa/ldap/LdapCACertificateManagement.rb +100 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootBootSecurity.rb +99 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootDef.rb +111 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootDevPrecision.rb +139 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootEfi.rb +107 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootHdd.rb +127 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootIscsi.rb +133 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootLan.rb +116 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootLocalStorage.rb +88 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootNVMe.rb +114 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootPchStorage.rb +120 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootPxe.rb +133 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootSan.rb +133 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootSd.rb +127 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootStorage.rb +107 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootUefiShell.rb +114 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootUsb.rb +124 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootVMedia.rb +138 -0
- data/lib/ImcSdk/mometa/lsboot/LsbootVirtualMedia.rb +108 -0
- data/lib/ImcSdk/mometa/memory/MemoryArray.rb +200 -0
- data/lib/ImcSdk/mometa/memory/MemoryUnit.rb +299 -0
- data/lib/ImcSdk/mometa/memory/MemoryUnitEnvStats.rb +112 -0
- data/lib/ImcSdk/mometa/mgmt/MgmtBackup.rb +172 -0
- data/lib/ImcSdk/mometa/mgmt/MgmtBackupServer.rb +132 -0
- data/lib/ImcSdk/mometa/mgmt/MgmtController.rb +118 -0
- data/lib/ImcSdk/mometa/mgmt/MgmtIf.rb +388 -0
- data/lib/ImcSdk/mometa/mgmt/MgmtImporter.rb +172 -0
- data/lib/ImcSdk/mometa/mgmt/MgmtImporterServer.rb +132 -0
- data/lib/ImcSdk/mometa/mgmt/MgmtInventory.rb +143 -0
- data/lib/ImcSdk/mometa/network/NetworkAdapterEthIf.rb +100 -0
- data/lib/ImcSdk/mometa/network/NetworkAdapterUnit.rb +116 -0
- data/lib/ImcSdk/mometa/one/OneTimeBootDevice.rb +103 -0
- data/lib/ImcSdk/mometa/one/OneTimePrecisionBootDevice.rb +116 -0
- data/lib/ImcSdk/mometa/osi/OsiCancel.rb +101 -0
- data/lib/ImcSdk/mometa/osi/OsiController.rb +94 -0
- data/lib/ImcSdk/mometa/osi/OsiStart.rb +266 -0
- data/lib/ImcSdk/mometa/osi/OsiStatus.rb +148 -0
- data/lib/ImcSdk/mometa/pci/PciEquipSlot.rb +124 -0
- data/lib/ImcSdk/mometa/pid/PidCatalog.rb +100 -0
- data/lib/ImcSdk/mometa/pid/PidCatalogCpu.rb +136 -0
- data/lib/ImcSdk/mometa/pid/PidCatalogDimm.rb +154 -0
- data/lib/ImcSdk/mometa/pid/PidCatalogHdd.rb +130 -0
- data/lib/ImcSdk/mometa/pid/PidCatalogPCIAdapter.rb +130 -0
- data/lib/ImcSdk/mometa/platform/PlatformEventFilters.rb +109 -0
- data/lib/ImcSdk/mometa/power/PowerBudget.rb +146 -0
- data/lib/ImcSdk/mometa/power/PowerMonitor.rb +123 -0
- data/lib/ImcSdk/mometa/processor/ProcessorEnvStats.rb +112 -0
- data/lib/ImcSdk/mometa/processor/ProcessorUnit.rb +213 -0
- data/lib/ImcSdk/mometa/self/SelfEncryptStorageController.rb +98 -0
- data/lib/ImcSdk/mometa/server/ServerUtilization.rb +112 -0
- data/lib/ImcSdk/mometa/sioc/SiocResetReason.rb +77 -0
- data/lib/ImcSdk/mometa/sol/SolIf.rb +128 -0
- data/lib/ImcSdk/mometa/standard/StandardPowerProfile.rb +108 -0
- data/lib/ImcSdk/mometa/storage/StorageController.rb +165 -0
- data/lib/ImcSdk/mometa/storage/StorageControllerHealth.rb +100 -0
- data/lib/ImcSdk/mometa/storage/StorageControllerNVMe.rb +154 -0
- data/lib/ImcSdk/mometa/storage/StorageControllerProps.rb +406 -0
- data/lib/ImcSdk/mometa/storage/StorageControllerSettings.rb +220 -0
- data/lib/ImcSdk/mometa/storage/StorageEnclosure.rb +82 -0
- data/lib/ImcSdk/mometa/storage/StorageEnclosureDisk.rb +149 -0
- data/lib/ImcSdk/mometa/storage/StorageEnclosureDiskFwHelper.rb +108 -0
- data/lib/ImcSdk/mometa/storage/StorageEnclosureDiskSlotEp.rb +85 -0
- data/lib/ImcSdk/mometa/storage/StorageEnclosureDiskSlotZoneHelper.rb +97 -0
- data/lib/ImcSdk/mometa/storage/StorageFlexFlashController.rb +193 -0
- data/lib/ImcSdk/mometa/storage/StorageFlexFlashControllerProps.rb +202 -0
- data/lib/ImcSdk/mometa/storage/StorageFlexFlashOperationalProfile.rb +164 -0
- data/lib/ImcSdk/mometa/storage/StorageFlexFlashPhysicalDrive.rb +256 -0
- data/lib/ImcSdk/mometa/storage/StorageFlexFlashVirtualDrive.rb +152 -0
- data/lib/ImcSdk/mometa/storage/StorageFlexFlashVirtualDriveImageMap.rb +145 -0
- data/lib/ImcSdk/mometa/storage/StorageLocalDisk.rb +247 -0
- data/lib/ImcSdk/mometa/storage/StorageLocalDiskEp.rb +77 -0
- data/lib/ImcSdk/mometa/storage/StorageLocalDiskProps.rb +250 -0
- data/lib/ImcSdk/mometa/storage/StorageLocalDiskSlotEp.rb +146 -0
- data/lib/ImcSdk/mometa/storage/StorageLocalDiskUsage.rb +124 -0
- data/lib/ImcSdk/mometa/storage/StorageOperation.rb +112 -0
- data/lib/ImcSdk/mometa/storage/StorageRaidBattery.rb +252 -0
- data/lib/ImcSdk/mometa/storage/StorageSasExpander.rb +113 -0
- data/lib/ImcSdk/mometa/storage/StorageSasUplink.rb +121 -0
- data/lib/ImcSdk/mometa/storage/StorageUnusedLocalDisk.rb +124 -0
- data/lib/ImcSdk/mometa/storage/StorageVirtualDrive.rb +307 -0
- data/lib/ImcSdk/mometa/storage/StorageVirtualDriveCreatorUsingUnusedPhysicalDrive.rb +223 -0
- data/lib/ImcSdk/mometa/storage/StorageVirtualDriveCreatorUsingVirtualDriveGroup.rb +199 -0
- data/lib/ImcSdk/mometa/storage/StorageVirtualDriveWithDriveGroupSpace.rb +130 -0
- data/lib/ImcSdk/mometa/suggested/SuggestedStorageControllerSecurityKey.rb +77 -0
- data/lib/ImcSdk/mometa/sysdebug/SysdebugMEpLog.rb +122 -0
- data/lib/ImcSdk/mometa/sysdebug/SysdebugTechSupportExport.rb +149 -0
- data/lib/ImcSdk/mometa/system/SystemIOController.rb +81 -0
- data/lib/ImcSdk/mometa/thermal/ThermalPowerProfile.rb +89 -0
- data/lib/ImcSdk/mometa/top/TopRoot.rb +88 -0
- data/lib/ImcSdk/mometa/top/TopSystem.rb +561 -0
- data/lib/ImcSdk/mometa/upload/UploadBiosProfile.rb +129 -0
- data/lib/ImcSdk/mometa/upload/UploadCertificate.rb +136 -0
- data/lib/ImcSdk/mometa/upload/UploadPIDCatalog.rb +129 -0
- data/lib/ImcSdk/version.rb +3 -0
- data/spec/ImcSdk_spec.rb +11 -0
- data/spec/spec_helper.rb +11 -0
- data/test/ImcSdk_bios_test.rb +57 -0
- data/test/ImcSdk_ipmi_test.rb +65 -0
- data/test/ImcSdk_ldap_test.rb +79 -0
- data/test/ImcSdk_ntp_test.rb +88 -0
- data/test/ImcSdk_powerbudget_test.rb +64 -0
- data/test/ImcSdk_remotepresence_test.rb +60 -0
- data/test/ImcSdk_serveractions_test.rb +69 -0
- data/test/ImcSdk_storage_test.rb +60 -0
- data/test/ImcSdk_user_test.rb +98 -0
- data/test/test_helper.rb +21 -0
- metadata +492 -0
data/Rakefile
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
require "bundler/gem_tasks"
|
|
2
|
+
require "rake/testtask"
|
|
3
|
+
#require "rspec/core/rake_task"
|
|
4
|
+
|
|
5
|
+
#RSpec::Core::RakeTask.new(:spec)
|
|
6
|
+
|
|
7
|
+
#task :default => :spec
|
|
8
|
+
|
|
9
|
+
Rake::TestTask.new do |t|
|
|
10
|
+
t.libs << "test"
|
|
11
|
+
t.test_files = FileList["test/**/*_test.rb"]
|
|
12
|
+
t.verbose = false
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
task default: :test
|
data/bin/console
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
require "bundler/setup"
|
|
4
|
+
require "ImcSdk"
|
|
5
|
+
|
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
|
8
|
+
|
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
|
10
|
+
# require "pry"
|
|
11
|
+
# Pry.start
|
|
12
|
+
|
|
13
|
+
require "irb"
|
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/docs/ImcHandle.html
ADDED
|
@@ -0,0 +1,2900 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: ImcHandle
|
|
8
|
+
|
|
9
|
+
— Cisco IMC Ruby SDK
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "ImcHandle";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index (I)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">ImcHandle</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: ImcHandle
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">ImcSession</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">ImcSession</li>
|
|
78
|
+
|
|
79
|
+
<li class="next">ImcHandle</li>
|
|
80
|
+
|
|
81
|
+
</ul>
|
|
82
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
83
|
+
|
|
84
|
+
</dd>
|
|
85
|
+
</dl>
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<dl>
|
|
98
|
+
<dt>Defined in:</dt>
|
|
99
|
+
<dd>lib/ImcSdk.rb</dd>
|
|
100
|
+
</dl>
|
|
101
|
+
|
|
102
|
+
</div>
|
|
103
|
+
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
|
105
|
+
<div class="discussion">
|
|
106
|
+
|
|
107
|
+
<p>ImcHandle class is the user interface point for any Imc communication.</p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
<p class="tag_title">Author:</p>
|
|
115
|
+
<ul class="author">
|
|
116
|
+
|
|
117
|
+
<li>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<div class='inline'>
|
|
124
|
+
<p>Amit Mandal(amimanda@cisco.com)</p>
|
|
125
|
+
</div>
|
|
126
|
+
|
|
127
|
+
</li>
|
|
128
|
+
|
|
129
|
+
</ul>
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
136
|
+
<ul class="summary">
|
|
137
|
+
|
|
138
|
+
<li class="public ">
|
|
139
|
+
<span class="summary_signature">
|
|
140
|
+
|
|
141
|
+
<a href="#to_commit-instance_method" title="#to_commit (instance method)">#<strong>to_commit</strong> ⇒ Object </a>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</span>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<span class="summary_desc"><div class='inline'>
|
|
159
|
+
<p>ImcHandle class is the user interface point for any Imc communication.</p>
|
|
160
|
+
</div></span>
|
|
161
|
+
|
|
162
|
+
</li>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
</ul>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<h2>
|
|
172
|
+
Instance Method Summary
|
|
173
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
174
|
+
</h2>
|
|
175
|
+
|
|
176
|
+
<ul class="summary">
|
|
177
|
+
|
|
178
|
+
<li class="public ">
|
|
179
|
+
<span class="summary_signature">
|
|
180
|
+
|
|
181
|
+
<a href="#add_mo-instance_method" title="#add_mo (instance method)">#<strong>add_mo</strong>(mo:, modify_present: true, timeout: "60") ⇒ nil </a>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</span>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<span class="summary_desc"><div class='inline'>
|
|
196
|
+
<p>Add a Managed Object to the IMC Server.</p>
|
|
197
|
+
</div></span>
|
|
198
|
+
|
|
199
|
+
</li>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<li class="public ">
|
|
203
|
+
<span class="summary_signature">
|
|
204
|
+
|
|
205
|
+
<a href="#get_auth_token-instance_method" title="#get_auth_token (instance method)">#<strong>get_auth_token</strong>(timeout: "60") ⇒ String </a>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
</span>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<span class="summary_desc"><div class='inline'>
|
|
220
|
+
<p>Returns a token that is used for IMC authentication.</p>
|
|
221
|
+
</div></span>
|
|
222
|
+
|
|
223
|
+
</li>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<li class="public ">
|
|
227
|
+
<span class="summary_signature">
|
|
228
|
+
|
|
229
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(ip:, username:, password:, port: "80", secure: nil, proxy: nil) ⇒ ImcHandle </a>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
</span>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<span class="note title constructor">constructor</span>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<span class="summary_desc"><div class='inline'>
|
|
246
|
+
<p>Create an object of ImcHandle class.</p>
|
|
247
|
+
</div></span>
|
|
248
|
+
|
|
249
|
+
</li>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
<li class="public ">
|
|
253
|
+
<span class="summary_signature">
|
|
254
|
+
|
|
255
|
+
<a href="#login-instance_method" title="#login (instance method)">#<strong>login</strong>(auto_refresh: false, force: false, timeout: "60") ⇒ TrueClass, FalseClass </a>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
</span>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
<span class="summary_desc"><div class='inline'>
|
|
270
|
+
<p>Initiated a connection to the server referenced by the ImcHandle.</p>
|
|
271
|
+
</div></span>
|
|
272
|
+
|
|
273
|
+
</li>
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<li class="public ">
|
|
277
|
+
<span class="summary_signature">
|
|
278
|
+
|
|
279
|
+
<a href="#logout-instance_method" title="#logout (instance method)">#<strong>logout</strong>(timeout: "60") ⇒ TrueClass, FalseClass </a>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
</span>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
<span class="summary_desc"><div class='inline'>
|
|
294
|
+
<p>Disconnects from the server referenced by the ImcHandle.</p>
|
|
295
|
+
</div></span>
|
|
296
|
+
|
|
297
|
+
</li>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
<li class="public ">
|
|
301
|
+
<span class="summary_signature">
|
|
302
|
+
|
|
303
|
+
<a href="#process_xml_elem-instance_method" title="#process_xml_elem (instance method)">#<strong>process_xml_elem</strong>(elem, timeout: "60") ⇒ External Method Object, MO List </a>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
</span>
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
<span class="summary_desc"><div class='inline'>
|
|
318
|
+
<p>process_xml_elem is a helper method which posts xml elements to the server
|
|
319
|
+
and returns parsed response.</p>
|
|
320
|
+
</div></span>
|
|
321
|
+
|
|
322
|
+
</li>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<li class="public ">
|
|
326
|
+
<span class="summary_signature">
|
|
327
|
+
|
|
328
|
+
<a href="#query_children-instance_method" title="#query_children (instance method)">#<strong>query_children</strong>(in_mo: nil, in_dn: nil, class_id: nil, hierarchy: false, timeout: "60") ⇒ Array<ManagedObject><sup>?</sup> </a>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
</span>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span class="summary_desc"><div class='inline'>
|
|
343
|
+
<p>Finds children of a given managed object or distinguished name.</p>
|
|
344
|
+
</div></span>
|
|
345
|
+
|
|
346
|
+
</li>
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
<li class="public ">
|
|
350
|
+
<span class="summary_signature">
|
|
351
|
+
|
|
352
|
+
<a href="#query_classid-instance_method" title="#query_classid (instance method)">#<strong>query_classid</strong>(class_id:, hierarchy: false, need_response: false, timeout: "60") ⇒ Array<ManagedObject>, ... </a>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
</span>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<span class="summary_desc"><div class='inline'>
|
|
367
|
+
<p>Finds an object using it's class id.</p>
|
|
368
|
+
</div></span>
|
|
369
|
+
|
|
370
|
+
</li>
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
<li class="public ">
|
|
374
|
+
<span class="summary_signature">
|
|
375
|
+
|
|
376
|
+
<a href="#query_dn-instance_method" title="#query_dn (instance method)">#<strong>query_dn</strong>(dn:, hierarchy: false, need_response: false, timeout: "60") ⇒ ManagedObject, ... </a>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
</span>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
<span class="summary_desc"><div class='inline'>
|
|
391
|
+
<p>Finds an object using it's distinguished name.</p>
|
|
392
|
+
</div></span>
|
|
393
|
+
|
|
394
|
+
</li>
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
<li class="public ">
|
|
398
|
+
<span class="summary_signature">
|
|
399
|
+
|
|
400
|
+
<a href="#remove_mo-instance_method" title="#remove_mo (instance method)">#<strong>remove_mo</strong>(mo:, timeout: "60") ⇒ nil </a>
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
</span>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
<span class="summary_desc"><div class='inline'>
|
|
415
|
+
<p>Remove a Managed Object from the IMC Server.</p>
|
|
416
|
+
</div></span>
|
|
417
|
+
|
|
418
|
+
</li>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
<li class="public ">
|
|
422
|
+
<span class="summary_signature">
|
|
423
|
+
|
|
424
|
+
<a href="#set_mo-instance_method" title="#set_mo (instance method)">#<strong>set_mo</strong>(mo:, timeout: "60") ⇒ nil </a>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
</span>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
<span class="summary_desc"><div class='inline'>
|
|
439
|
+
<p>Modifies a managed object and adds it to the ImcHandle commit buffer (if
|
|
440
|
+
not already in it).</p>
|
|
441
|
+
</div></span>
|
|
442
|
+
|
|
443
|
+
</li>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
</ul>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<div id="constructor_details" class="method_details_list">
|
|
451
|
+
<h2>Constructor Details</h2>
|
|
452
|
+
|
|
453
|
+
<div class="method_details first">
|
|
454
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
455
|
+
|
|
456
|
+
#<strong>initialize</strong>(ip:, username:, password:, port: "80", secure: nil, proxy: nil) ⇒ <tt><span class='object_link'><a href="" title="ImcHandle (class)">ImcHandle</a></span></tt>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
</h3><div class="docstring">
|
|
463
|
+
<div class="discussion">
|
|
464
|
+
|
|
465
|
+
<p>Create an object of ImcHandle class</p>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
</div>
|
|
470
|
+
<div class="tags">
|
|
471
|
+
|
|
472
|
+
<div class="examples">
|
|
473
|
+
<p class="tag_title">Examples:</p>
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
<pre class="example code"><code>handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password")</code></pre>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
<pre class="example code"><code>handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", secure: true)</code></pre>
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
<pre class="example code"><code>handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", secure: false)</code></pre>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
<pre class="example code"><code>handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", port: 80)</code></pre>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<pre class="example code"><code>handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", port: 443)</code></pre>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
<pre class="example code"><code>handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", port: 100, secure: true)</code></pre>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="ImcHandle (class)">ImcHandle</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='label'>ip:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>192.168.1.1</span><span class='tstring_end'>"</span></span><span class='comma'>,</span><span class='label'>username:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>admin</span><span class='tstring_end'>"</span></span><span class='comma'>,</span><span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>password</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>port:</span> <span class='int'>100</span><span class='comma'>,</span> <span class='label'>secure:</span> <span class='kw'>false</span><span class='rparen'>)</span></code></pre>
|
|
495
|
+
|
|
496
|
+
</div>
|
|
497
|
+
<p class="tag_title">Parameters:</p>
|
|
498
|
+
<ul class="param">
|
|
499
|
+
|
|
500
|
+
<li>
|
|
501
|
+
|
|
502
|
+
<span class='name'>ip</span>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
—
|
|
510
|
+
<div class='inline'>
|
|
511
|
+
<p>The IP or Hostname of the IMC Server</p>
|
|
512
|
+
</div>
|
|
513
|
+
|
|
514
|
+
</li>
|
|
515
|
+
|
|
516
|
+
<li>
|
|
517
|
+
|
|
518
|
+
<span class='name'>username</span>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
—
|
|
526
|
+
<div class='inline'>
|
|
527
|
+
<p>The username as configured on the Imc Server</p>
|
|
528
|
+
</div>
|
|
529
|
+
|
|
530
|
+
</li>
|
|
531
|
+
|
|
532
|
+
<li>
|
|
533
|
+
|
|
534
|
+
<span class='name'>password</span>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
—
|
|
542
|
+
<div class='inline'>
|
|
543
|
+
<p>The password as configured on the Imc Server</p>
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
</li>
|
|
547
|
+
|
|
548
|
+
<li>
|
|
549
|
+
|
|
550
|
+
<span class='name'>port</span>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
—
|
|
558
|
+
<div class='inline'>
|
|
559
|
+
<p>The port number to be used during connection</p>
|
|
560
|
+
</div>
|
|
561
|
+
|
|
562
|
+
</li>
|
|
563
|
+
|
|
564
|
+
<li>
|
|
565
|
+
|
|
566
|
+
<span class='name'>secure</span>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
<span class='type'>(<tt>bool</tt>, <tt>nil</tt>)</span>
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
—
|
|
574
|
+
<div class='inline'>
|
|
575
|
+
<p>true for secure connection, otherwise false</p>
|
|
576
|
+
</div>
|
|
577
|
+
|
|
578
|
+
</li>
|
|
579
|
+
|
|
580
|
+
<li>
|
|
581
|
+
|
|
582
|
+
<span class='name'>proxy</span>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
<span class='type'>(<tt>String</tt>, <tt>nil</tt>)</span>
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
—
|
|
590
|
+
<div class='inline'>
|
|
591
|
+
<p>The proxy object to be used to connect</p>
|
|
592
|
+
</div>
|
|
593
|
+
|
|
594
|
+
</li>
|
|
595
|
+
|
|
596
|
+
</ul>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
</div><table class="source_code">
|
|
600
|
+
<tr>
|
|
601
|
+
<td>
|
|
602
|
+
<pre class="lines">
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
40
|
|
606
|
+
41
|
|
607
|
+
42
|
|
608
|
+
43</pre>
|
|
609
|
+
</td>
|
|
610
|
+
<td>
|
|
611
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 40</span>
|
|
612
|
+
|
|
613
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>ip:</span><span class='comma'>,</span> <span class='label'>username:</span><span class='comma'>,</span> <span class='label'>password:</span><span class='comma'>,</span> <span class='label'>port:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>80</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>secure:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>proxy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
614
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='label'>ip:</span> <span class='id identifier rubyid_ip'>ip</span><span class='comma'>,</span> <span class='label'>username:</span> <span class='id identifier rubyid_username'>username</span><span class='comma'>,</span> <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='label'>port:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span> <span class='label'>secure:</span> <span class='id identifier rubyid_secure'>secure</span><span class='comma'>,</span> <span class='label'>proxy:</span> <span class='id identifier rubyid_proxy'>proxy</span><span class='rparen'>)</span>
|
|
615
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
616
|
+
<span class='kw'>end</span></pre>
|
|
617
|
+
</td>
|
|
618
|
+
</tr>
|
|
619
|
+
</table>
|
|
620
|
+
</div>
|
|
621
|
+
|
|
622
|
+
</div>
|
|
623
|
+
|
|
624
|
+
<div id="instance_attr_details" class="attr_details">
|
|
625
|
+
<h2>Instance Attribute Details</h2>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
<span id="to_commit=-instance_method"></span>
|
|
629
|
+
<div class="method_details first">
|
|
630
|
+
<h3 class="signature first" id="to_commit-instance_method">
|
|
631
|
+
|
|
632
|
+
#<strong>to_commit</strong> ⇒ <tt>Object</tt>
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
</h3><div class="docstring">
|
|
639
|
+
<div class="discussion">
|
|
640
|
+
|
|
641
|
+
<p>ImcHandle class is the user interface point for any Imc communication.</p>
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
</div>
|
|
645
|
+
</div>
|
|
646
|
+
<div class="tags">
|
|
647
|
+
|
|
648
|
+
<p class="tag_title">Author:</p>
|
|
649
|
+
<ul class="author">
|
|
650
|
+
|
|
651
|
+
<li>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
<div class='inline'>
|
|
658
|
+
<p>Amit Mandal(amimanda@cisco.com)</p>
|
|
659
|
+
</div>
|
|
660
|
+
|
|
661
|
+
</li>
|
|
662
|
+
|
|
663
|
+
</ul>
|
|
664
|
+
|
|
665
|
+
</div><table class="source_code">
|
|
666
|
+
<tr>
|
|
667
|
+
<td>
|
|
668
|
+
<pre class="lines">
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
13
|
|
672
|
+
14
|
|
673
|
+
15
|
|
674
|
+
16
|
|
675
|
+
17
|
|
676
|
+
18
|
|
677
|
+
19
|
|
678
|
+
20
|
|
679
|
+
21
|
|
680
|
+
22
|
|
681
|
+
23
|
|
682
|
+
24
|
|
683
|
+
25
|
|
684
|
+
26
|
|
685
|
+
27
|
|
686
|
+
28
|
|
687
|
+
29
|
|
688
|
+
30
|
|
689
|
+
31
|
|
690
|
+
32
|
|
691
|
+
33
|
|
692
|
+
34
|
|
693
|
+
35
|
|
694
|
+
36
|
|
695
|
+
37
|
|
696
|
+
38
|
|
697
|
+
39
|
|
698
|
+
40
|
|
699
|
+
41
|
|
700
|
+
42
|
|
701
|
+
43
|
|
702
|
+
44
|
|
703
|
+
45
|
|
704
|
+
46
|
|
705
|
+
47
|
|
706
|
+
48
|
|
707
|
+
49
|
|
708
|
+
50
|
|
709
|
+
51
|
|
710
|
+
52
|
|
711
|
+
53
|
|
712
|
+
54
|
|
713
|
+
55
|
|
714
|
+
56
|
|
715
|
+
57
|
|
716
|
+
58
|
|
717
|
+
59
|
|
718
|
+
60
|
|
719
|
+
61
|
|
720
|
+
62
|
|
721
|
+
63
|
|
722
|
+
64
|
|
723
|
+
65
|
|
724
|
+
66
|
|
725
|
+
67
|
|
726
|
+
68
|
|
727
|
+
69
|
|
728
|
+
70
|
|
729
|
+
71
|
|
730
|
+
72
|
|
731
|
+
73
|
|
732
|
+
74
|
|
733
|
+
75
|
|
734
|
+
76
|
|
735
|
+
77
|
|
736
|
+
78
|
|
737
|
+
79
|
|
738
|
+
80
|
|
739
|
+
81
|
|
740
|
+
82
|
|
741
|
+
83
|
|
742
|
+
84
|
|
743
|
+
85
|
|
744
|
+
86
|
|
745
|
+
87
|
|
746
|
+
88
|
|
747
|
+
89
|
|
748
|
+
90
|
|
749
|
+
91
|
|
750
|
+
92
|
|
751
|
+
93
|
|
752
|
+
94
|
|
753
|
+
95
|
|
754
|
+
96
|
|
755
|
+
97
|
|
756
|
+
98
|
|
757
|
+
99
|
|
758
|
+
100
|
|
759
|
+
101
|
|
760
|
+
102
|
|
761
|
+
103
|
|
762
|
+
104
|
|
763
|
+
105
|
|
764
|
+
106
|
|
765
|
+
107
|
|
766
|
+
108
|
|
767
|
+
109
|
|
768
|
+
110
|
|
769
|
+
111
|
|
770
|
+
112
|
|
771
|
+
113
|
|
772
|
+
114
|
|
773
|
+
115
|
|
774
|
+
116
|
|
775
|
+
117
|
|
776
|
+
118
|
|
777
|
+
119
|
|
778
|
+
120
|
|
779
|
+
121
|
|
780
|
+
122
|
|
781
|
+
123
|
|
782
|
+
124
|
|
783
|
+
125
|
|
784
|
+
126
|
|
785
|
+
127
|
|
786
|
+
128
|
|
787
|
+
129
|
|
788
|
+
130
|
|
789
|
+
131
|
|
790
|
+
132
|
|
791
|
+
133
|
|
792
|
+
134
|
|
793
|
+
135
|
|
794
|
+
136
|
|
795
|
+
137
|
|
796
|
+
138
|
|
797
|
+
139
|
|
798
|
+
140
|
|
799
|
+
141
|
|
800
|
+
142
|
|
801
|
+
143
|
|
802
|
+
144
|
|
803
|
+
145
|
|
804
|
+
146
|
|
805
|
+
147
|
|
806
|
+
148
|
|
807
|
+
149
|
|
808
|
+
150
|
|
809
|
+
151
|
|
810
|
+
152
|
|
811
|
+
153
|
|
812
|
+
154
|
|
813
|
+
155
|
|
814
|
+
156
|
|
815
|
+
157
|
|
816
|
+
158
|
|
817
|
+
159
|
|
818
|
+
160
|
|
819
|
+
161
|
|
820
|
+
162
|
|
821
|
+
163
|
|
822
|
+
164
|
|
823
|
+
165
|
|
824
|
+
166
|
|
825
|
+
167
|
|
826
|
+
168
|
|
827
|
+
169
|
|
828
|
+
170
|
|
829
|
+
171
|
|
830
|
+
172
|
|
831
|
+
173
|
|
832
|
+
174
|
|
833
|
+
175
|
|
834
|
+
176
|
|
835
|
+
177
|
|
836
|
+
178
|
|
837
|
+
179
|
|
838
|
+
180
|
|
839
|
+
181
|
|
840
|
+
182
|
|
841
|
+
183
|
|
842
|
+
184
|
|
843
|
+
185
|
|
844
|
+
186
|
|
845
|
+
187
|
|
846
|
+
188
|
|
847
|
+
189
|
|
848
|
+
190
|
|
849
|
+
191
|
|
850
|
+
192
|
|
851
|
+
193
|
|
852
|
+
194
|
|
853
|
+
195
|
|
854
|
+
196
|
|
855
|
+
197
|
|
856
|
+
198
|
|
857
|
+
199
|
|
858
|
+
200
|
|
859
|
+
201
|
|
860
|
+
202
|
|
861
|
+
203
|
|
862
|
+
204
|
|
863
|
+
205
|
|
864
|
+
206
|
|
865
|
+
207
|
|
866
|
+
208
|
|
867
|
+
209
|
|
868
|
+
210
|
|
869
|
+
211
|
|
870
|
+
212
|
|
871
|
+
213
|
|
872
|
+
214
|
|
873
|
+
215
|
|
874
|
+
216
|
|
875
|
+
217
|
|
876
|
+
218
|
|
877
|
+
219
|
|
878
|
+
220
|
|
879
|
+
221
|
|
880
|
+
222
|
|
881
|
+
223
|
|
882
|
+
224
|
|
883
|
+
225
|
|
884
|
+
226
|
|
885
|
+
227
|
|
886
|
+
228
|
|
887
|
+
229
|
|
888
|
+
230
|
|
889
|
+
231
|
|
890
|
+
232
|
|
891
|
+
233
|
|
892
|
+
234
|
|
893
|
+
235
|
|
894
|
+
236
|
|
895
|
+
237
|
|
896
|
+
238
|
|
897
|
+
239
|
|
898
|
+
240
|
|
899
|
+
241
|
|
900
|
+
242
|
|
901
|
+
243
|
|
902
|
+
244
|
|
903
|
+
245
|
|
904
|
+
246
|
|
905
|
+
247
|
|
906
|
+
248
|
|
907
|
+
249
|
|
908
|
+
250
|
|
909
|
+
251
|
|
910
|
+
252
|
|
911
|
+
253
|
|
912
|
+
254
|
|
913
|
+
255
|
|
914
|
+
256
|
|
915
|
+
257
|
|
916
|
+
258
|
|
917
|
+
259
|
|
918
|
+
260
|
|
919
|
+
261
|
|
920
|
+
262
|
|
921
|
+
263
|
|
922
|
+
264
|
|
923
|
+
265
|
|
924
|
+
266
|
|
925
|
+
267
|
|
926
|
+
268
|
|
927
|
+
269
|
|
928
|
+
270
|
|
929
|
+
271
|
|
930
|
+
272
|
|
931
|
+
273
|
|
932
|
+
274
|
|
933
|
+
275
|
|
934
|
+
276
|
|
935
|
+
277
|
|
936
|
+
278
|
|
937
|
+
279
|
|
938
|
+
280
|
|
939
|
+
281
|
|
940
|
+
282
|
|
941
|
+
283
|
|
942
|
+
284
|
|
943
|
+
285
|
|
944
|
+
286
|
|
945
|
+
287
|
|
946
|
+
288
|
|
947
|
+
289
|
|
948
|
+
290
|
|
949
|
+
291
|
|
950
|
+
292
|
|
951
|
+
293
|
|
952
|
+
294
|
|
953
|
+
295
|
|
954
|
+
296
|
|
955
|
+
297
|
|
956
|
+
298
|
|
957
|
+
299
|
|
958
|
+
300
|
|
959
|
+
301
|
|
960
|
+
302
|
|
961
|
+
303
|
|
962
|
+
304
|
|
963
|
+
305
|
|
964
|
+
306
|
|
965
|
+
307
|
|
966
|
+
308
|
|
967
|
+
309
|
|
968
|
+
310
|
|
969
|
+
311
|
|
970
|
+
312
|
|
971
|
+
313
|
|
972
|
+
314
|
|
973
|
+
315
|
|
974
|
+
316
|
|
975
|
+
317
|
|
976
|
+
318
|
|
977
|
+
319
|
|
978
|
+
320
|
|
979
|
+
321
|
|
980
|
+
322
|
|
981
|
+
323
|
|
982
|
+
324
|
|
983
|
+
325
|
|
984
|
+
326
|
|
985
|
+
327
|
|
986
|
+
328
|
|
987
|
+
329
|
|
988
|
+
330
|
|
989
|
+
331
|
|
990
|
+
332
|
|
991
|
+
333
|
|
992
|
+
334
|
|
993
|
+
335
|
|
994
|
+
336
|
|
995
|
+
337
|
|
996
|
+
338
|
|
997
|
+
339
|
|
998
|
+
340
|
|
999
|
+
341
|
|
1000
|
+
342
|
|
1001
|
+
343
|
|
1002
|
+
344
|
|
1003
|
+
345
|
|
1004
|
+
346
|
|
1005
|
+
347
|
|
1006
|
+
348
|
|
1007
|
+
349
|
|
1008
|
+
350
|
|
1009
|
+
351
|
|
1010
|
+
352
|
|
1011
|
+
353
|
|
1012
|
+
354
|
|
1013
|
+
355
|
|
1014
|
+
356
|
|
1015
|
+
357
|
|
1016
|
+
358
|
|
1017
|
+
359
|
|
1018
|
+
360
|
|
1019
|
+
361
|
|
1020
|
+
362
|
|
1021
|
+
363
|
|
1022
|
+
364
|
|
1023
|
+
365
|
|
1024
|
+
366
|
|
1025
|
+
367
|
|
1026
|
+
368
|
|
1027
|
+
369
|
|
1028
|
+
370
|
|
1029
|
+
371
|
|
1030
|
+
372
|
|
1031
|
+
373
|
|
1032
|
+
374
|
|
1033
|
+
375
|
|
1034
|
+
376
|
|
1035
|
+
377
|
|
1036
|
+
378
|
|
1037
|
+
379
|
|
1038
|
+
380
|
|
1039
|
+
381
|
|
1040
|
+
382
|
|
1041
|
+
383
|
|
1042
|
+
384
|
|
1043
|
+
385
|
|
1044
|
+
386
|
|
1045
|
+
387
|
|
1046
|
+
388
|
|
1047
|
+
389
|
|
1048
|
+
390
|
|
1049
|
+
391
|
|
1050
|
+
392
|
|
1051
|
+
393
|
|
1052
|
+
394
|
|
1053
|
+
395</pre>
|
|
1054
|
+
</td>
|
|
1055
|
+
<td>
|
|
1056
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 13</span>
|
|
1057
|
+
|
|
1058
|
+
<span class='kw'>class</span> <span class='const'><span class='object_link'><a href="" title="ImcHandle (class)">ImcHandle</a></span></span> <span class='op'><</span> <span class='const'>ImcSession</span>
|
|
1059
|
+
|
|
1060
|
+
<span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:to_commit</span>
|
|
1061
|
+
|
|
1062
|
+
<span class='comment'># Create an object of ImcHandle class
|
|
1063
|
+
</span> <span class='comment'>#
|
|
1064
|
+
</span> <span class='comment'># @param ip [String] The IP or Hostname of the IMC Server
|
|
1065
|
+
</span> <span class='comment'># @param username [String] The username as configured on the Imc Server
|
|
1066
|
+
</span> <span class='comment'># @param password [String] The password as configured on the Imc Server
|
|
1067
|
+
</span> <span class='comment'># @param port [Integer, nil] The port number to be used during connection
|
|
1068
|
+
</span> <span class='comment'># @param secure [bool, nil] true for secure connection, otherwise false
|
|
1069
|
+
</span> <span class='comment'># @param proxy [String, nil] The proxy object to be used to connect
|
|
1070
|
+
</span> <span class='comment'># @example
|
|
1071
|
+
</span> <span class='comment'># handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password")
|
|
1072
|
+
</span> <span class='comment'># @example
|
|
1073
|
+
</span> <span class='comment'># handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", secure: true)
|
|
1074
|
+
</span> <span class='comment'># @example
|
|
1075
|
+
</span> <span class='comment'># handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", secure: false)
|
|
1076
|
+
</span> <span class='comment'># @example
|
|
1077
|
+
</span> <span class='comment'># handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", port: 80)
|
|
1078
|
+
</span> <span class='comment'># @example
|
|
1079
|
+
</span> <span class='comment'># handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", port: 443)
|
|
1080
|
+
</span> <span class='comment'># @example
|
|
1081
|
+
</span> <span class='comment'># handle = ImcHandle.new (ip: "192.168.1.1",username: "admin",password: "password", port: 100, secure: true)
|
|
1082
|
+
</span> <span class='comment'># @example
|
|
1083
|
+
</span> <span class='comment'># handle = ImcHandle.new(ip: "192.168.1.1",username: "admin",password: "password", port: 100, secure: false)
|
|
1084
|
+
</span>
|
|
1085
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>ip:</span><span class='comma'>,</span> <span class='label'>username:</span><span class='comma'>,</span> <span class='label'>password:</span><span class='comma'>,</span> <span class='label'>port:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>80</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>secure:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>proxy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1086
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='label'>ip:</span> <span class='id identifier rubyid_ip'>ip</span><span class='comma'>,</span> <span class='label'>username:</span> <span class='id identifier rubyid_username'>username</span><span class='comma'>,</span> <span class='label'>password:</span> <span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='label'>port:</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span> <span class='label'>secure:</span> <span class='id identifier rubyid_secure'>secure</span><span class='comma'>,</span> <span class='label'>proxy:</span> <span class='id identifier rubyid_proxy'>proxy</span><span class='rparen'>)</span>
|
|
1087
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1088
|
+
<span class='kw'>end</span>
|
|
1089
|
+
|
|
1090
|
+
<span class='comment'>#def set_dump_xml()
|
|
1091
|
+
</span> <span class='comment'># #Enables the logging of xml requests and responses
|
|
1092
|
+
</span> <span class='comment'># super
|
|
1093
|
+
</span> <span class='comment'>#end
|
|
1094
|
+
</span>
|
|
1095
|
+
<span class='comment'>#def unset_dump_xml()
|
|
1096
|
+
</span> <span class='comment'>#Disables the logging of xml request and responses
|
|
1097
|
+
</span> <span class='comment'># super
|
|
1098
|
+
</span> <span class='comment'>#end
|
|
1099
|
+
</span>
|
|
1100
|
+
<span class='comment'># Initiated a connection to the server referenced by the ImcHandle. A cookie is populated in the ImcHandle, if the login is successful.
|
|
1101
|
+
</span> <span class='comment'>#
|
|
1102
|
+
</span> <span class='comment'># @param auto_refresh [TrueClass, FalseCalss] If set to true, it refresh the cookie continuously
|
|
1103
|
+
</span> <span class='comment'># @param force [TrueClass, FalseClass] If set to true it reconnects even if cookie exists and is valid for respective connection.
|
|
1104
|
+
</span> <span class='comment'># @param timeout [Integer] Timeout value in seconds
|
|
1105
|
+
</span> <span class='comment'># @return [TrueClass, FalseClass] true on successful connect
|
|
1106
|
+
</span> <span class='comment'># @example
|
|
1107
|
+
</span> <span class='comment'># handle.login()
|
|
1108
|
+
</span> <span class='comment'># @example
|
|
1109
|
+
</span> <span class='comment'># handle.login(auto_refresh: true)
|
|
1110
|
+
</span> <span class='comment'># @example
|
|
1111
|
+
</span> <span class='comment'># handle.login(force: true)
|
|
1112
|
+
</span> <span class='comment'># @example
|
|
1113
|
+
</span> <span class='comment'># handle.login(auto_refresh: true, force: true)
|
|
1114
|
+
</span> <span class='comment'># @note Where handle is an object of ImcHandle class.
|
|
1115
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='label'>auto_refresh:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>force:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1116
|
+
<span class='kw'>return</span> <span class='id identifier rubyid__login'>_login</span><span class='lparen'>(</span><span class='label'>auto_refresh:</span> <span class='id identifier rubyid_auto_refresh'>auto_refresh</span><span class='comma'>,</span> <span class='label'>force:</span> <span class='id identifier rubyid_force'>force</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1117
|
+
<span class='kw'>end</span>
|
|
1118
|
+
|
|
1119
|
+
<span class='comment'># Disconnects from the server referenced by the ImcHandle.
|
|
1120
|
+
</span> <span class='comment'>#
|
|
1121
|
+
</span> <span class='comment'># @param timeout [Integer] timeout value in seconds.
|
|
1122
|
+
</span> <span class='comment'># @return [TrueClass, FalseClass] true on successful disconnect
|
|
1123
|
+
</span> <span class='comment'>#
|
|
1124
|
+
</span> <span class='comment'># @example
|
|
1125
|
+
</span> <span class='comment'># handle.logout()
|
|
1126
|
+
</span> <span class='comment'># @example
|
|
1127
|
+
</span> <span class='comment'># handle.logout(timout: 60)
|
|
1128
|
+
</span> <span class='comment'># @note Where handle is an object of ImcHandle class.
|
|
1129
|
+
</span>
|
|
1130
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_logout'>logout</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1131
|
+
<span class='kw'>return</span> <span class='id identifier rubyid__logout'>_logout</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1132
|
+
<span class='kw'>end</span>
|
|
1133
|
+
|
|
1134
|
+
<span class='comment'>#
|
|
1135
|
+
</span> <span class='comment'># process_xml_elem is a helper method which posts xml elements to the
|
|
1136
|
+
</span> <span class='comment'># server and returns parsed response. It's role is to operate on the
|
|
1137
|
+
</span> <span class='comment'># output of methods from Imcmethodfactory, which return xml element
|
|
1138
|
+
</span> <span class='comment'># node(s).
|
|
1139
|
+
</span> <span class='comment'>#
|
|
1140
|
+
</span> <span class='comment'># @param elem [] XML Element Object
|
|
1141
|
+
</span> <span class='comment'># @return [External Method Object, MO List] MO List or External Method Object
|
|
1142
|
+
</span> <span class='comment'>#
|
|
1143
|
+
</span> <span class='comment'># @example
|
|
1144
|
+
</span> <span class='comment'># elem = imcmethodfactory.config_resolve_class(cookie: handle.cookie, class_id: "computeRackUnit")
|
|
1145
|
+
</span> <span class='comment'># objs = handle.process_xml_elem(elem)
|
|
1146
|
+
</span> <span class='comment'>#
|
|
1147
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_process_xml_elem'>process_xml_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1148
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1149
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
1150
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
1151
|
+
<span class='kw'>end</span>
|
|
1152
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_is_outconfig_available'>is_outconfig_available</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
1153
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_get_outconfig_child'>get_outconfig_child</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
1154
|
+
<span class='kw'>else</span>
|
|
1155
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
|
|
1156
|
+
<span class='kw'>end</span>
|
|
1157
|
+
<span class='kw'>end</span>
|
|
1158
|
+
|
|
1159
|
+
<span class='comment'># Returns a token that is used for IMC authentication.
|
|
1160
|
+
</span> <span class='comment'>#
|
|
1161
|
+
</span> <span class='comment'># @param timeout [Integer] timeout value(in seconds)
|
|
1162
|
+
</span> <span class='comment'># @return [String] Token used for IMC Authentication
|
|
1163
|
+
</span> <span class='comment'>#
|
|
1164
|
+
</span> <span class='comment'># @example
|
|
1165
|
+
</span> <span class='comment'># handle.get_auth_token()
|
|
1166
|
+
</span> <span class='comment'>#
|
|
1167
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_get_auth_token'>get_auth_token</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1168
|
+
|
|
1169
|
+
<span class='id identifier rubyid_auth_token'>auth_token</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1170
|
+
<span class='id identifier rubyid_mo'>mo</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span> <span class='const'>NamingId</span><span class='op'>::</span><span class='const'>COMPUTE_BOARD</span><span class='rparen'>)</span>
|
|
1171
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1172
|
+
<span class='id identifier rubyid_mo'>mo</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span> <span class='const'>NamingId</span><span class='op'>::</span><span class='const'>COMPUTE_RACK_UNIT</span><span class='rparen'>)</span>
|
|
1173
|
+
<span class='kw'>end</span>
|
|
1174
|
+
|
|
1175
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1176
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_aaa_get_compute_auth_tokens'>aaa_get_compute_auth_tokens</span><span class='lparen'>(</span><span class='label'>cookie:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='rparen'>)</span>
|
|
1177
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1178
|
+
|
|
1179
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
1180
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
1181
|
+
<span class='kw'>end</span>
|
|
1182
|
+
|
|
1183
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_defined?'>instance_variable_defined?</span><span class='lparen'>(</span><span class='symbol'>:@out_tokens</span><span class='rparen'>)</span>
|
|
1184
|
+
<span class='id identifier rubyid_auth_token'>auth_token</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:@out_tokens</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
1185
|
+
<span class='kw'>end</span>
|
|
1186
|
+
<span class='kw'>end</span>
|
|
1187
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_auth_token'>auth_token</span>
|
|
1188
|
+
<span class='kw'>end</span>
|
|
1189
|
+
|
|
1190
|
+
<span class='comment'>#
|
|
1191
|
+
</span> <span class='comment'># Finds an object using it's distinguished name.
|
|
1192
|
+
</span> <span class='comment'>#
|
|
1193
|
+
</span> <span class='comment'># @param dn [String] distinguished name of the object to be queried for.
|
|
1194
|
+
</span> <span class='comment'># @param hierarchy [TrueClass, FalseClass] Gets all objects in hierarchy if true
|
|
1195
|
+
</span> <span class='comment'># @param need_response [TrueClass, FalseClass] returns the response xml node, instead of parsed objects.
|
|
1196
|
+
</span> <span class='comment'># @param timeout [Integer] timeout value(in seconds)
|
|
1197
|
+
</span> <span class='comment'># @return [ManagedObject, Array<ManagedObject>, ExternalMethod] Return Managed Object by default, returns Array<ManagedObject> if hierarchy is set to true,
|
|
1198
|
+
</span> <span class='comment'># returns ExternalMethod if need_response is set to true.
|
|
1199
|
+
</span> <span class='comment'>#
|
|
1200
|
+
</span> <span class='comment'># @example
|
|
1201
|
+
</span> <span class='comment'># obj = handle.query_dn(dn: "sys/rack-unit-1")
|
|
1202
|
+
</span> <span class='comment'># @example
|
|
1203
|
+
</span> <span class='comment'># obj = handle.query_dn(dn: "sys/rack-unit-1", hierarchy: true)
|
|
1204
|
+
</span> <span class='comment'># @example
|
|
1205
|
+
</span> <span class='comment'># obj = handle.query_dn(dn: "sys/rack-unit-1", need_response: true
|
|
1206
|
+
</span> <span class='comment'># @example
|
|
1207
|
+
</span> <span class='comment'># obj = handle.query_dn(dn: "sys/rack-unit-1", hierarchy: true, need_response: true)
|
|
1208
|
+
</span>
|
|
1209
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_query_dn'>query_dn</span><span class='lparen'>(</span><span class='label'>dn:</span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>need_response:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1210
|
+
|
|
1211
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_dn'>dn</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1212
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ValueError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Provide dn.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1213
|
+
<span class='kw'>end</span>
|
|
1214
|
+
|
|
1215
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_config_resolve_dn'>config_resolve_dn</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span> <span class='id identifier rubyid_dn'>dn</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
1216
|
+
|
|
1217
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1218
|
+
|
|
1219
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
1220
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
1221
|
+
<span class='kw'>end</span>
|
|
1222
|
+
|
|
1223
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_need_response'>need_response</span>
|
|
1224
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
|
|
1225
|
+
<span class='kw'>end</span>
|
|
1226
|
+
|
|
1227
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span>
|
|
1228
|
+
<span class='id identifier rubyid_out_mo_list'>out_mo_list</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_extract_molist_from_method_response'>extract_molist_from_method_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
1229
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_out_mo_list'>out_mo_list</span>
|
|
1230
|
+
<span class='kw'>end</span>
|
|
1231
|
+
|
|
1232
|
+
<span class='id identifier rubyid_mo'>mo</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1233
|
+
<span class='id identifier rubyid_child'>child</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_get_outconfig_child'>get_outconfig_child</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
1234
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_child'>child</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>0</span>
|
|
1235
|
+
<span class='id identifier rubyid_mo'>mo</span> <span class='op'>=</span> <span class='id identifier rubyid_child'>child</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
1236
|
+
<span class='kw'>end</span>
|
|
1237
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_mo'>mo</span>
|
|
1238
|
+
<span class='kw'>end</span>
|
|
1239
|
+
|
|
1240
|
+
<span class='comment'>#
|
|
1241
|
+
</span> <span class='comment'># Finds an object using it's class id.
|
|
1242
|
+
</span> <span class='comment'>#
|
|
1243
|
+
</span> <span class='comment'># @param class_id [String] class id of the object to be queried for.
|
|
1244
|
+
</span> <span class='comment'># @param hierarchy [TrueClass, FalseClass] if set to true will return all the child hierarchical objects.
|
|
1245
|
+
</span> <span class='comment'># @param need_response [TrueClass, FalseClass] if set to true will return only response object.
|
|
1246
|
+
</span> <span class='comment'># @param timeout [Integer] timeout value(in seconds)
|
|
1247
|
+
</span> <span class='comment'># @return [Array<ManagedObject>, Method_Response, nil] returns Method_Response if need_response is set to true
|
|
1248
|
+
</span> <span class='comment'>#
|
|
1249
|
+
</span> <span class='comment'># @example
|
|
1250
|
+
</span> <span class='comment'># obj = handle.query_classid(class_id: "computeRackUnit")
|
|
1251
|
+
</span> <span class='comment'># @example
|
|
1252
|
+
</span> <span class='comment'># obj = handle.query_classid(class_id: "computeRackUnit", hierarchy: true)
|
|
1253
|
+
</span> <span class='comment'># @example
|
|
1254
|
+
</span> <span class='comment'># obj = handle.query_classid(class_id: "computeRackUnit", need_response: true)
|
|
1255
|
+
</span> <span class='comment'>#
|
|
1256
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>need_response:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
|
|
1257
|
+
|
|
1258
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_class_id'>class_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1259
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ValueError</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Provide Parameter class_id</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1260
|
+
<span class='kw'>end</span>
|
|
1261
|
+
|
|
1262
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_find_class_id_in_mo_meta_ignore_case'>find_class_id_in_mo_meta_ignore_case</span><span class='lparen'>(</span><span class='id identifier rubyid_class_id'>class_id</span><span class='rparen'>)</span>
|
|
1263
|
+
|
|
1264
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_meta_class_id'>meta_class_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1265
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_class_id'>class_id</span>
|
|
1266
|
+
<span class='kw'>end</span>
|
|
1267
|
+
|
|
1268
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_config_resolve_class'>config_resolve_class</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span> <span class='id identifier rubyid_class_id'>class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_meta_class_id'>meta_class_id</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
1269
|
+
|
|
1270
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1271
|
+
|
|
1272
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
1273
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
1274
|
+
<span class='kw'>end</span>
|
|
1275
|
+
|
|
1276
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_need_response'>need_response</span>
|
|
1277
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
|
|
1278
|
+
<span class='kw'>end</span>
|
|
1279
|
+
|
|
1280
|
+
<span class='id identifier rubyid_out_mo_list'>out_mo_list</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_extract_molist_from_method_response'>extract_molist_from_method_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
1281
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_out_mo_list'>out_mo_list</span>
|
|
1282
|
+
|
|
1283
|
+
<span class='kw'>end</span>
|
|
1284
|
+
|
|
1285
|
+
<span class='comment'>#
|
|
1286
|
+
</span> <span class='comment'># Finds children of a given managed object or distinguished name.
|
|
1287
|
+
</span> <span class='comment'># Arguments can be specified to query only a specific type(class_id) of children.
|
|
1288
|
+
</span> <span class='comment'># Arguments can also be specified to query only direct children or the entire hierarchy of children.
|
|
1289
|
+
</span> <span class='comment'>#
|
|
1290
|
+
</span> <span class='comment'># @param in_mo [ManagedObject] query children managed object under this object.
|
|
1291
|
+
</span> <span class='comment'># @param in_dn [String] query children managed object for a given managed object of the respective dn.
|
|
1292
|
+
</span> <span class='comment'># @param class_id [String] by default nil, if given finds only specific childred object for a given class_id.
|
|
1293
|
+
</span> <span class='comment'># @param hierarchy [TrueClass, FalseClass] if set to true will return all the child hierarchical objects.
|
|
1294
|
+
</span> <span class='comment'># @param timeout [Integer] timeout value in seconds
|
|
1295
|
+
</span> <span class='comment'># @return [Array<ManagedObject>, nil]
|
|
1296
|
+
</span> <span class='comment'>#
|
|
1297
|
+
</span> <span class='comment'># @example
|
|
1298
|
+
</span> <span class='comment'># mo_list = handle.query_children(in_mo: mo)
|
|
1299
|
+
</span> <span class='comment'># @example
|
|
1300
|
+
</span> <span class='comment'># mo_list = handle.query_children(in_mo: mo, class_id: "classid")
|
|
1301
|
+
</span> <span class='comment'># @example
|
|
1302
|
+
</span> <span class='comment'># mo_list = handle.query_children(in_dn: dn)
|
|
1303
|
+
</span> <span class='comment'># @example
|
|
1304
|
+
</span> <span class='comment'># mo_list = handle.query_children(in_dn: dn, class_id: "classid")
|
|
1305
|
+
</span> <span class='comment'>#
|
|
1306
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_query_children'>query_children</span><span class='lparen'>(</span><span class='label'>in_mo:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>in_dn:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>class_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1307
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_in_mo'>in_mo</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='id identifier rubyid_in_dn'>in_dn</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1308
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ValueError</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[Error]: GetChild: Provide in_mo or in_dn</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1309
|
+
<span class='kw'>end</span>
|
|
1310
|
+
|
|
1311
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_in_mo'>in_mo</span>
|
|
1312
|
+
<span class='id identifier rubyid_parent_dn'>parent_dn</span> <span class='op'>=</span> <span class='id identifier rubyid_in_mo'>in_mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span>
|
|
1313
|
+
<span class='kw'>elsif</span>
|
|
1314
|
+
<span class='id identifier rubyid_parent_dn'>parent_dn</span> <span class='op'>=</span> <span class='id identifier rubyid_in_dn'>in_dn</span>
|
|
1315
|
+
<span class='kw'>end</span>
|
|
1316
|
+
|
|
1317
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_class_id'>class_id</span>
|
|
1318
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_find_class_id_in_mo_meta_ignore_case'>find_class_id_in_mo_meta_ignore_case</span><span class='lparen'>(</span><span class='id identifier rubyid_class_id'>class_id</span><span class='rparen'>)</span>
|
|
1319
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_meta_class_id'>meta_class_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1320
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_class_id'>class_id</span>
|
|
1321
|
+
<span class='kw'>end</span>
|
|
1322
|
+
<span class='kw'>else</span>
|
|
1323
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_class_id'>class_id</span>
|
|
1324
|
+
<span class='kw'>end</span>
|
|
1325
|
+
|
|
1326
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_config_resolve_children'>config_resolve_children</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span> <span class='id identifier rubyid_class_id'>class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_meta_class_id'>meta_class_id</span><span class='comma'>,</span> <span class='id identifier rubyid_in_dn'>in_dn</span> <span class='op'>=</span> <span class='id identifier rubyid_parent_dn'>parent_dn</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
1327
|
+
|
|
1328
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1329
|
+
|
|
1330
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
1331
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
1332
|
+
<span class='kw'>end</span>
|
|
1333
|
+
|
|
1334
|
+
<span class='id identifier rubyid_out_mo_list'>out_mo_list</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_extract_molist_from_method_response'>extract_molist_from_method_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
1335
|
+
|
|
1336
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_out_mo_list'>out_mo_list</span>
|
|
1337
|
+
<span class='kw'>end</span>
|
|
1338
|
+
<span class='comment'>#
|
|
1339
|
+
</span> <span class='comment'># Add a Managed Object to the IMC Server
|
|
1340
|
+
</span> <span class='comment'>#
|
|
1341
|
+
</span> <span class='comment'># @param mo [ManagedObject] Managed Object to the added to the IMC Server
|
|
1342
|
+
</span> <span class='comment'># @param modify_present [TrueClass, FalseClass] Over-write an existing object if true
|
|
1343
|
+
</span> <span class='comment'># @param timeout [Integer] timoeout value(in seconds)
|
|
1344
|
+
</span> <span class='comment'># @return [nil]
|
|
1345
|
+
</span> <span class='comment'># @example
|
|
1346
|
+
</span> <span class='comment'># handle.add_mo(mo: mo)
|
|
1347
|
+
</span> <span class='comment'>#
|
|
1348
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_add_mo'>add_mo</span><span class='lparen'>(</span><span class='label'>mo:</span><span class='comma'>,</span> <span class='label'>modify_present:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1349
|
+
<span class='kw'>if</span> <span class='const'>ImcGenUtils</span><span class='op'>::</span><span class='const'>AFFIRMATIVE_LIST</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_modify_present'>modify_present</span>
|
|
1350
|
+
<span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_query_dn'>query_dn</span><span class='lparen'>(</span><span class='label'>dn:</span> <span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1351
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>created</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1352
|
+
<span class='kw'>else</span>
|
|
1353
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>modified</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1354
|
+
<span class='kw'>end</span>
|
|
1355
|
+
<span class='kw'>else</span>
|
|
1356
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>created</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1357
|
+
<span class='kw'>end</span>
|
|
1358
|
+
|
|
1359
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span><span class='lbracket'>[</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mo'>mo</span>
|
|
1360
|
+
<span class='id identifier rubyid__commit'>_commit</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1361
|
+
<span class='kw'>end</span>
|
|
1362
|
+
|
|
1363
|
+
<span class='comment'>#
|
|
1364
|
+
</span> <span class='comment'># Modifies a managed object and adds it to the ImcHandle commit buffer (if not already in it)
|
|
1365
|
+
</span> <span class='comment'>#
|
|
1366
|
+
</span> <span class='comment'># @param mo [ManagedObject] Managed Object with modified properties
|
|
1367
|
+
</span> <span class='comment'># @param timeout [Integer, nil] timeout value in seconds
|
|
1368
|
+
</span> <span class='comment'># @return [nil]
|
|
1369
|
+
</span> <span class='comment'>#
|
|
1370
|
+
</span> <span class='comment'># @example
|
|
1371
|
+
</span> <span class='comment'># handle.set_mo(mo: mo)
|
|
1372
|
+
</span> <span class='comment'>#
|
|
1373
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_set_mo'>set_mo</span><span class='lparen'>(</span><span class='label'>mo:</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1374
|
+
<span class='comment'>#mo.instance_variable_set(:@status, "modified")
|
|
1375
|
+
</span> <span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>modified</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1376
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span><span class='lbracket'>[</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:@dn</span><span class='rparen'>)</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mo'>mo</span>
|
|
1377
|
+
<span class='id identifier rubyid__commit'>_commit</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1378
|
+
<span class='kw'>end</span>
|
|
1379
|
+
|
|
1380
|
+
<span class='comment'>#
|
|
1381
|
+
</span> <span class='comment'># Remove a Managed Object from the IMC Server
|
|
1382
|
+
</span> <span class='comment'>#
|
|
1383
|
+
</span> <span class='comment'># @param mo [ManagedObject] Managed Object to be removed.
|
|
1384
|
+
</span> <span class='comment'># @param timeout [Integer] timeout value(in seconds).
|
|
1385
|
+
</span> <span class='comment'># @return [nil] Nothing is returned.
|
|
1386
|
+
</span> <span class='comment'>#
|
|
1387
|
+
</span> <span class='comment'># @example
|
|
1388
|
+
</span> <span class='comment'># handle.remove_mo(mo: mo)
|
|
1389
|
+
</span> <span class='comment'>#
|
|
1390
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid_remove_mo'>remove_mo</span><span class='lparen'>(</span><span class='label'>mo:</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1391
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>deleted</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1392
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_defined?'>instance_variable_defined?</span><span class='lparen'>(</span><span class='symbol'>:@parent_mo</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='op'>!</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_parent_mo'>parent_mo</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1393
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_parent_mo'>parent_mo</span><span class='period'>.</span><span class='id identifier rubyid_child_remove'>child_remove</span><span class='lparen'>(</span><span class='id identifier rubyid_mo'>mo</span><span class='rparen'>)</span>
|
|
1394
|
+
<span class='kw'>end</span>
|
|
1395
|
+
|
|
1396
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span><span class='lbracket'>[</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mo'>mo</span>
|
|
1397
|
+
<span class='id identifier rubyid__commit'>_commit</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1398
|
+
<span class='kw'>end</span>
|
|
1399
|
+
|
|
1400
|
+
<span class='comment'>#private methods
|
|
1401
|
+
</span><span class='id identifier rubyid_private'>private</span>
|
|
1402
|
+
<span class='comment'>#
|
|
1403
|
+
</span> <span class='comment'># Commit the buffer to the server. Pushes all the configuration changes so far to the server.
|
|
1404
|
+
</span> <span class='comment'># Configuration could be added to the commit buffer using add_mo(), set_mo(), and remove_mo().
|
|
1405
|
+
</span> <span class='comment'>#
|
|
1406
|
+
</span> <span class='comment'># @param timeout [Integer] timeout value in seconds.
|
|
1407
|
+
</span> <span class='comment'># @return [nil]
|
|
1408
|
+
</span> <span class='comment'># @example
|
|
1409
|
+
</span> <span class='comment'># self._commit()
|
|
1410
|
+
</span> <span class='comment'>#
|
|
1411
|
+
</span> <span class='kw'>def</span> <span class='id identifier rubyid__commit'>_commit</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1412
|
+
|
|
1413
|
+
<span class='id identifier rubyid_mo_dict'>mo_dict</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span>
|
|
1414
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_mo_dict'>mo_dict</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>or</span> <span class='id identifier rubyid_mo_dict'>mo_dict</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
|
|
1415
|
+
<span class='kw'>return</span> <span class='kw'>nil</span>
|
|
1416
|
+
<span class='kw'>end</span>
|
|
1417
|
+
|
|
1418
|
+
<span class='id identifier rubyid_config_map'>config_map</span> <span class='op'>=</span> <span class='const'>ConfigMap</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
1419
|
+
|
|
1420
|
+
<span class='id identifier rubyid_mo_dict'>mo_dict</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_mo_dn'>mo_dn</span><span class='comma'>,</span> <span class='id identifier rubyid_mo'>mo</span><span class='op'>|</span>
|
|
1421
|
+
<span class='id identifier rubyid_config_map'>config_map</span><span class='period'>.</span><span class='id identifier rubyid_child_add'>child_add</span><span class='lparen'>(</span><span class='id identifier rubyid_mo'>mo</span><span class='rparen'>)</span>
|
|
1422
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_config_conf_mo'>config_conf_mo</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span> <span class='id identifier rubyid_mo_dn'>mo_dn</span><span class='comma'>,</span> <span class='id identifier rubyid_config_map'>config_map</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
|
1423
|
+
|
|
1424
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1425
|
+
|
|
1426
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
1427
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1428
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
1429
|
+
<span class='kw'>end</span>
|
|
1430
|
+
|
|
1431
|
+
<span class='id identifier rubyid_child'>child</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_get_outconfig_child'>get_outconfig_child</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
1432
|
+
<span class='kw'>for</span> <span class='id identifier rubyid_pair_'>pair_</span> <span class='kw'>in</span> <span class='id identifier rubyid_child'>child</span> <span class='kw'>do</span>
|
|
1433
|
+
<span class='kw'>for</span> <span class='id identifier rubyid_out_mo'>out_mo</span> <span class='kw'>in</span> <span class='id identifier rubyid_pair_'>pair_</span><span class='period'>.</span><span class='id identifier rubyid_child'>child</span> <span class='kw'>do</span>
|
|
1434
|
+
<span class='id identifier rubyid_out_mo'>out_mo</span><span class='period'>.</span><span class='id identifier rubyid_sync_mo'>sync_mo</span><span class='lparen'>(</span><span class='id identifier rubyid_mo_dict'>mo_dict</span><span class='lbracket'>[</span><span class='id identifier rubyid_out_mo'>out_mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
1435
|
+
<span class='kw'>end</span>
|
|
1436
|
+
<span class='kw'>end</span>
|
|
1437
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1438
|
+
<span class='kw'>end</span>
|
|
1439
|
+
<span class='kw'>end</span>
|
|
1440
|
+
<span class='kw'>end</span></pre>
|
|
1441
|
+
</td>
|
|
1442
|
+
</tr>
|
|
1443
|
+
</table>
|
|
1444
|
+
</div>
|
|
1445
|
+
|
|
1446
|
+
</div>
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
<div id="instance_method_details" class="method_details_list">
|
|
1450
|
+
<h2>Instance Method Details</h2>
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
<div class="method_details first">
|
|
1454
|
+
<h3 class="signature first" id="add_mo-instance_method">
|
|
1455
|
+
|
|
1456
|
+
#<strong>add_mo</strong>(mo:, modify_present: true, timeout: "60") ⇒ <tt>nil</tt>
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
</h3><div class="docstring">
|
|
1463
|
+
<div class="discussion">
|
|
1464
|
+
|
|
1465
|
+
<p>Add a Managed Object to the IMC Server</p>
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
</div>
|
|
1469
|
+
</div>
|
|
1470
|
+
<div class="tags">
|
|
1471
|
+
|
|
1472
|
+
<div class="examples">
|
|
1473
|
+
<p class="tag_title">Examples:</p>
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_add_mo'>add_mo</span><span class='lparen'>(</span><span class='label'>mo:</span> <span class='id identifier rubyid_mo'>mo</span><span class='rparen'>)</span></code></pre>
|
|
1477
|
+
|
|
1478
|
+
</div>
|
|
1479
|
+
<p class="tag_title">Parameters:</p>
|
|
1480
|
+
<ul class="param">
|
|
1481
|
+
|
|
1482
|
+
<li>
|
|
1483
|
+
|
|
1484
|
+
<span class='name'>mo</span>
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
<span class='type'>(<tt>ManagedObject</tt>)</span>
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
—
|
|
1492
|
+
<div class='inline'>
|
|
1493
|
+
<p>Managed Object to the added to the IMC Server</p>
|
|
1494
|
+
</div>
|
|
1495
|
+
|
|
1496
|
+
</li>
|
|
1497
|
+
|
|
1498
|
+
<li>
|
|
1499
|
+
|
|
1500
|
+
<span class='name'>modify_present</span>
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
—
|
|
1508
|
+
<div class='inline'>
|
|
1509
|
+
<p>Over-write an existing object if true</p>
|
|
1510
|
+
</div>
|
|
1511
|
+
|
|
1512
|
+
</li>
|
|
1513
|
+
|
|
1514
|
+
<li>
|
|
1515
|
+
|
|
1516
|
+
<span class='name'>timeout</span>
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
—
|
|
1524
|
+
<div class='inline'>
|
|
1525
|
+
<p>timoeout value(in seconds)</p>
|
|
1526
|
+
</div>
|
|
1527
|
+
|
|
1528
|
+
</li>
|
|
1529
|
+
|
|
1530
|
+
</ul>
|
|
1531
|
+
|
|
1532
|
+
<p class="tag_title">Returns:</p>
|
|
1533
|
+
<ul class="return">
|
|
1534
|
+
|
|
1535
|
+
<li>
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
</li>
|
|
1543
|
+
|
|
1544
|
+
</ul>
|
|
1545
|
+
|
|
1546
|
+
</div><table class="source_code">
|
|
1547
|
+
<tr>
|
|
1548
|
+
<td>
|
|
1549
|
+
<pre class="lines">
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
303
|
|
1553
|
+
304
|
|
1554
|
+
305
|
|
1555
|
+
306
|
|
1556
|
+
307
|
|
1557
|
+
308
|
|
1558
|
+
309
|
|
1559
|
+
310
|
|
1560
|
+
311
|
|
1561
|
+
312
|
|
1562
|
+
313
|
|
1563
|
+
314
|
|
1564
|
+
315
|
|
1565
|
+
316</pre>
|
|
1566
|
+
</td>
|
|
1567
|
+
<td>
|
|
1568
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 303</span>
|
|
1569
|
+
|
|
1570
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_add_mo'>add_mo</span><span class='lparen'>(</span><span class='label'>mo:</span><span class='comma'>,</span> <span class='label'>modify_present:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1571
|
+
<span class='kw'>if</span> <span class='const'>ImcGenUtils</span><span class='op'>::</span><span class='const'>AFFIRMATIVE_LIST</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_modify_present'>modify_present</span>
|
|
1572
|
+
<span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_query_dn'>query_dn</span><span class='lparen'>(</span><span class='label'>dn:</span> <span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1573
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>created</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1574
|
+
<span class='kw'>else</span>
|
|
1575
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>modified</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1576
|
+
<span class='kw'>end</span>
|
|
1577
|
+
<span class='kw'>else</span>
|
|
1578
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>created</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1579
|
+
<span class='kw'>end</span>
|
|
1580
|
+
|
|
1581
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span><span class='lbracket'>[</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mo'>mo</span>
|
|
1582
|
+
<span class='id identifier rubyid__commit'>_commit</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1583
|
+
<span class='kw'>end</span></pre>
|
|
1584
|
+
</td>
|
|
1585
|
+
</tr>
|
|
1586
|
+
</table>
|
|
1587
|
+
</div>
|
|
1588
|
+
|
|
1589
|
+
<div class="method_details ">
|
|
1590
|
+
<h3 class="signature " id="get_auth_token-instance_method">
|
|
1591
|
+
|
|
1592
|
+
#<strong>get_auth_token</strong>(timeout: "60") ⇒ <tt>String</tt>
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
</h3><div class="docstring">
|
|
1599
|
+
<div class="discussion">
|
|
1600
|
+
|
|
1601
|
+
<p>Returns a token that is used for IMC authentication.</p>
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
</div>
|
|
1605
|
+
</div>
|
|
1606
|
+
<div class="tags">
|
|
1607
|
+
|
|
1608
|
+
<div class="examples">
|
|
1609
|
+
<p class="tag_title">Examples:</p>
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_get_auth_token'>get_auth_token</span><span class='lparen'>(</span><span class='rparen'>)</span></code></pre>
|
|
1613
|
+
|
|
1614
|
+
</div>
|
|
1615
|
+
<p class="tag_title">Parameters:</p>
|
|
1616
|
+
<ul class="param">
|
|
1617
|
+
|
|
1618
|
+
<li>
|
|
1619
|
+
|
|
1620
|
+
<span class='name'>timeout</span>
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
—
|
|
1628
|
+
<div class='inline'>
|
|
1629
|
+
<p>timeout value(in seconds)</p>
|
|
1630
|
+
</div>
|
|
1631
|
+
|
|
1632
|
+
</li>
|
|
1633
|
+
|
|
1634
|
+
</ul>
|
|
1635
|
+
|
|
1636
|
+
<p class="tag_title">Returns:</p>
|
|
1637
|
+
<ul class="return">
|
|
1638
|
+
|
|
1639
|
+
<li>
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
—
|
|
1647
|
+
<div class='inline'>
|
|
1648
|
+
<p>Token used for IMC Authentication</p>
|
|
1649
|
+
</div>
|
|
1650
|
+
|
|
1651
|
+
</li>
|
|
1652
|
+
|
|
1653
|
+
</ul>
|
|
1654
|
+
|
|
1655
|
+
</div><table class="source_code">
|
|
1656
|
+
<tr>
|
|
1657
|
+
<td>
|
|
1658
|
+
<pre class="lines">
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
122
|
|
1662
|
+
123
|
|
1663
|
+
124
|
|
1664
|
+
125
|
|
1665
|
+
126
|
|
1666
|
+
127
|
|
1667
|
+
128
|
|
1668
|
+
129
|
|
1669
|
+
130
|
|
1670
|
+
131
|
|
1671
|
+
132
|
|
1672
|
+
133
|
|
1673
|
+
134
|
|
1674
|
+
135
|
|
1675
|
+
136
|
|
1676
|
+
137
|
|
1677
|
+
138
|
|
1678
|
+
139
|
|
1679
|
+
140
|
|
1680
|
+
141
|
|
1681
|
+
142
|
|
1682
|
+
143</pre>
|
|
1683
|
+
</td>
|
|
1684
|
+
<td>
|
|
1685
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 122</span>
|
|
1686
|
+
|
|
1687
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_auth_token'>get_auth_token</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1688
|
+
|
|
1689
|
+
<span class='id identifier rubyid_auth_token'>auth_token</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1690
|
+
<span class='id identifier rubyid_mo'>mo</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span> <span class='const'>NamingId</span><span class='op'>::</span><span class='const'>COMPUTE_BOARD</span><span class='rparen'>)</span>
|
|
1691
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1692
|
+
<span class='id identifier rubyid_mo'>mo</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span> <span class='const'>NamingId</span><span class='op'>::</span><span class='const'>COMPUTE_RACK_UNIT</span><span class='rparen'>)</span>
|
|
1693
|
+
<span class='kw'>end</span>
|
|
1694
|
+
|
|
1695
|
+
<span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
1696
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_aaa_get_compute_auth_tokens'>aaa_get_compute_auth_tokens</span><span class='lparen'>(</span><span class='label'>cookie:</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='rparen'>)</span>
|
|
1697
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1698
|
+
|
|
1699
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
1700
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
1701
|
+
<span class='kw'>end</span>
|
|
1702
|
+
|
|
1703
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_defined?'>instance_variable_defined?</span><span class='lparen'>(</span><span class='symbol'>:@out_tokens</span><span class='rparen'>)</span>
|
|
1704
|
+
<span class='id identifier rubyid_auth_token'>auth_token</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:@out_tokens</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>,</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
|
1705
|
+
<span class='kw'>end</span>
|
|
1706
|
+
<span class='kw'>end</span>
|
|
1707
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_auth_token'>auth_token</span>
|
|
1708
|
+
<span class='kw'>end</span></pre>
|
|
1709
|
+
</td>
|
|
1710
|
+
</tr>
|
|
1711
|
+
</table>
|
|
1712
|
+
</div>
|
|
1713
|
+
|
|
1714
|
+
<div class="method_details ">
|
|
1715
|
+
<h3 class="signature " id="login-instance_method">
|
|
1716
|
+
|
|
1717
|
+
#<strong>login</strong>(auto_refresh: false, force: false, timeout: "60") ⇒ <tt>TrueClass</tt>, <tt>FalseClass</tt>
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
</h3><div class="docstring">
|
|
1724
|
+
<div class="discussion">
|
|
1725
|
+
|
|
1726
|
+
<div class="note notetag">
|
|
1727
|
+
<strong>Note:</strong>
|
|
1728
|
+
<div class='inline'>
|
|
1729
|
+
<p>Where handle is an object of ImcHandle class.</p>
|
|
1730
|
+
</div>
|
|
1731
|
+
</div>
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
<p>Initiated a connection to the server referenced by the ImcHandle. A cookie
|
|
1735
|
+
is populated in the ImcHandle, if the login is successful.</p>
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
</div>
|
|
1739
|
+
</div>
|
|
1740
|
+
<div class="tags">
|
|
1741
|
+
|
|
1742
|
+
<div class="examples">
|
|
1743
|
+
<p class="tag_title">Examples:</p>
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='rparen'>)</span></code></pre>
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='label'>auto_refresh:</span> <span class='kw'>true</span><span class='rparen'>)</span></code></pre>
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='label'>force:</span> <span class='kw'>true</span><span class='rparen'>)</span></code></pre>
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='label'>auto_refresh:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>force:</span> <span class='kw'>true</span><span class='rparen'>)</span></code></pre>
|
|
1756
|
+
|
|
1757
|
+
</div>
|
|
1758
|
+
<p class="tag_title">Parameters:</p>
|
|
1759
|
+
<ul class="param">
|
|
1760
|
+
|
|
1761
|
+
<li>
|
|
1762
|
+
|
|
1763
|
+
<span class='name'>auto_refresh</span>
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseCalss</tt>)</span>
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
—
|
|
1771
|
+
<div class='inline'>
|
|
1772
|
+
<p>If set to true, it refresh the cookie continuously</p>
|
|
1773
|
+
</div>
|
|
1774
|
+
|
|
1775
|
+
</li>
|
|
1776
|
+
|
|
1777
|
+
<li>
|
|
1778
|
+
|
|
1779
|
+
<span class='name'>force</span>
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
—
|
|
1787
|
+
<div class='inline'>
|
|
1788
|
+
<p>If set to true it reconnects even if cookie exists and is valid for
|
|
1789
|
+
respective connection.</p>
|
|
1790
|
+
</div>
|
|
1791
|
+
|
|
1792
|
+
</li>
|
|
1793
|
+
|
|
1794
|
+
<li>
|
|
1795
|
+
|
|
1796
|
+
<span class='name'>timeout</span>
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
—
|
|
1804
|
+
<div class='inline'>
|
|
1805
|
+
<p>Timeout value in seconds</p>
|
|
1806
|
+
</div>
|
|
1807
|
+
|
|
1808
|
+
</li>
|
|
1809
|
+
|
|
1810
|
+
</ul>
|
|
1811
|
+
|
|
1812
|
+
<p class="tag_title">Returns:</p>
|
|
1813
|
+
<ul class="return">
|
|
1814
|
+
|
|
1815
|
+
<li>
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
—
|
|
1823
|
+
<div class='inline'>
|
|
1824
|
+
<p>true on successful connect</p>
|
|
1825
|
+
</div>
|
|
1826
|
+
|
|
1827
|
+
</li>
|
|
1828
|
+
|
|
1829
|
+
</ul>
|
|
1830
|
+
|
|
1831
|
+
</div><table class="source_code">
|
|
1832
|
+
<tr>
|
|
1833
|
+
<td>
|
|
1834
|
+
<pre class="lines">
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
70
|
|
1838
|
+
71
|
|
1839
|
+
72</pre>
|
|
1840
|
+
</td>
|
|
1841
|
+
<td>
|
|
1842
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 70</span>
|
|
1843
|
+
|
|
1844
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_login'>login</span><span class='lparen'>(</span><span class='label'>auto_refresh:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>force:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1845
|
+
<span class='kw'>return</span> <span class='id identifier rubyid__login'>_login</span><span class='lparen'>(</span><span class='label'>auto_refresh:</span> <span class='id identifier rubyid_auto_refresh'>auto_refresh</span><span class='comma'>,</span> <span class='label'>force:</span> <span class='id identifier rubyid_force'>force</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1846
|
+
<span class='kw'>end</span></pre>
|
|
1847
|
+
</td>
|
|
1848
|
+
</tr>
|
|
1849
|
+
</table>
|
|
1850
|
+
</div>
|
|
1851
|
+
|
|
1852
|
+
<div class="method_details ">
|
|
1853
|
+
<h3 class="signature " id="logout-instance_method">
|
|
1854
|
+
|
|
1855
|
+
#<strong>logout</strong>(timeout: "60") ⇒ <tt>TrueClass</tt>, <tt>FalseClass</tt>
|
|
1856
|
+
|
|
1857
|
+
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
</h3><div class="docstring">
|
|
1862
|
+
<div class="discussion">
|
|
1863
|
+
|
|
1864
|
+
<div class="note notetag">
|
|
1865
|
+
<strong>Note:</strong>
|
|
1866
|
+
<div class='inline'>
|
|
1867
|
+
<p>Where handle is an object of ImcHandle class.</p>
|
|
1868
|
+
</div>
|
|
1869
|
+
</div>
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
<p>Disconnects from the server referenced by the ImcHandle.</p>
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
</div>
|
|
1876
|
+
</div>
|
|
1877
|
+
<div class="tags">
|
|
1878
|
+
|
|
1879
|
+
<div class="examples">
|
|
1880
|
+
<p class="tag_title">Examples:</p>
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_logout'>logout</span><span class='lparen'>(</span><span class='rparen'>)</span></code></pre>
|
|
1884
|
+
|
|
1885
|
+
|
|
1886
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_logout'>logout</span><span class='lparen'>(</span><span class='label'>timout:</span> <span class='int'>60</span><span class='rparen'>)</span></code></pre>
|
|
1887
|
+
|
|
1888
|
+
</div>
|
|
1889
|
+
<p class="tag_title">Parameters:</p>
|
|
1890
|
+
<ul class="param">
|
|
1891
|
+
|
|
1892
|
+
<li>
|
|
1893
|
+
|
|
1894
|
+
<span class='name'>timeout</span>
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
—
|
|
1902
|
+
<div class='inline'>
|
|
1903
|
+
<p>timeout value in seconds.</p>
|
|
1904
|
+
</div>
|
|
1905
|
+
|
|
1906
|
+
</li>
|
|
1907
|
+
|
|
1908
|
+
</ul>
|
|
1909
|
+
|
|
1910
|
+
<p class="tag_title">Returns:</p>
|
|
1911
|
+
<ul class="return">
|
|
1912
|
+
|
|
1913
|
+
<li>
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
—
|
|
1921
|
+
<div class='inline'>
|
|
1922
|
+
<p>true on successful disconnect</p>
|
|
1923
|
+
</div>
|
|
1924
|
+
|
|
1925
|
+
</li>
|
|
1926
|
+
|
|
1927
|
+
</ul>
|
|
1928
|
+
|
|
1929
|
+
</div><table class="source_code">
|
|
1930
|
+
<tr>
|
|
1931
|
+
<td>
|
|
1932
|
+
<pre class="lines">
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
85
|
|
1936
|
+
86
|
|
1937
|
+
87</pre>
|
|
1938
|
+
</td>
|
|
1939
|
+
<td>
|
|
1940
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 85</span>
|
|
1941
|
+
|
|
1942
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_logout'>logout</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1943
|
+
<span class='kw'>return</span> <span class='id identifier rubyid__logout'>_logout</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
1944
|
+
<span class='kw'>end</span></pre>
|
|
1945
|
+
</td>
|
|
1946
|
+
</tr>
|
|
1947
|
+
</table>
|
|
1948
|
+
</div>
|
|
1949
|
+
|
|
1950
|
+
<div class="method_details ">
|
|
1951
|
+
<h3 class="signature " id="process_xml_elem-instance_method">
|
|
1952
|
+
|
|
1953
|
+
#<strong>process_xml_elem</strong>(elem, timeout: "60") ⇒ <tt>External Method Object</tt>, <tt>MO List</tt>
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
|
|
1959
|
+
</h3><div class="docstring">
|
|
1960
|
+
<div class="discussion">
|
|
1961
|
+
|
|
1962
|
+
<p>process_xml_elem is a helper method which posts xml elements to the server
|
|
1963
|
+
and returns parsed response. It's role is to operate on the output of
|
|
1964
|
+
methods from Imcmethodfactory, which return xml element node(s).</p>
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
</div>
|
|
1968
|
+
</div>
|
|
1969
|
+
<div class="tags">
|
|
1970
|
+
|
|
1971
|
+
<div class="examples">
|
|
1972
|
+
<p class="tag_title">Examples:</p>
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
<pre class="example code"><code><span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_imcmethodfactory'>imcmethodfactory</span><span class='period'>.</span><span class='id identifier rubyid_config_resolve_class'>config_resolve_class</span><span class='lparen'>(</span><span class='label'>cookie:</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span> <span class='label'>class_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>computeRackUnit</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1976
|
+
<span class='id identifier rubyid_objs'>objs</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_process_xml_elem'>process_xml_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='rparen'>)</span></code></pre>
|
|
1977
|
+
|
|
1978
|
+
</div>
|
|
1979
|
+
<p class="tag_title">Parameters:</p>
|
|
1980
|
+
<ul class="param">
|
|
1981
|
+
|
|
1982
|
+
<li>
|
|
1983
|
+
|
|
1984
|
+
<span class='name'>elem</span>
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
<span class='type'></span>
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
—
|
|
1992
|
+
<div class='inline'><dl class="rdoc-list label-list"><dt>
|
|
1993
|
+
<dd>
|
|
1994
|
+
<p>XML Element Object</p>
|
|
1995
|
+
</dd></dl>
|
|
1996
|
+
</div>
|
|
1997
|
+
|
|
1998
|
+
</li>
|
|
1999
|
+
|
|
2000
|
+
</ul>
|
|
2001
|
+
|
|
2002
|
+
<p class="tag_title">Returns:</p>
|
|
2003
|
+
<ul class="return">
|
|
2004
|
+
|
|
2005
|
+
<li>
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
<span class='type'>(<tt>External Method Object</tt>, <tt>MO List</tt>)</span>
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
—
|
|
2013
|
+
<div class='inline'>
|
|
2014
|
+
<p>MO List or External Method Object</p>
|
|
2015
|
+
</div>
|
|
2016
|
+
|
|
2017
|
+
</li>
|
|
2018
|
+
|
|
2019
|
+
</ul>
|
|
2020
|
+
|
|
2021
|
+
</div><table class="source_code">
|
|
2022
|
+
<tr>
|
|
2023
|
+
<td>
|
|
2024
|
+
<pre class="lines">
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
102
|
|
2028
|
+
103
|
|
2029
|
+
104
|
|
2030
|
+
105
|
|
2031
|
+
106
|
|
2032
|
+
107
|
|
2033
|
+
108
|
|
2034
|
+
109
|
|
2035
|
+
110
|
|
2036
|
+
111
|
|
2037
|
+
112</pre>
|
|
2038
|
+
</td>
|
|
2039
|
+
<td>
|
|
2040
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 102</span>
|
|
2041
|
+
|
|
2042
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_process_xml_elem'>process_xml_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2043
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
2044
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
2045
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
2046
|
+
<span class='kw'>end</span>
|
|
2047
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_is_outconfig_available'>is_outconfig_available</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
2048
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_get_outconfig_child'>get_outconfig_child</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
2049
|
+
<span class='kw'>else</span>
|
|
2050
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
|
|
2051
|
+
<span class='kw'>end</span>
|
|
2052
|
+
<span class='kw'>end</span></pre>
|
|
2053
|
+
</td>
|
|
2054
|
+
</tr>
|
|
2055
|
+
</table>
|
|
2056
|
+
</div>
|
|
2057
|
+
|
|
2058
|
+
<div class="method_details ">
|
|
2059
|
+
<h3 class="signature " id="query_children-instance_method">
|
|
2060
|
+
|
|
2061
|
+
#<strong>query_children</strong>(in_mo: nil, in_dn: nil, class_id: nil, hierarchy: false, timeout: "60") ⇒ <tt>Array<ManagedObject></tt><sup>?</sup>
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
</h3><div class="docstring">
|
|
2068
|
+
<div class="discussion">
|
|
2069
|
+
|
|
2070
|
+
<p>Finds children of a given managed object or distinguished name. Arguments
|
|
2071
|
+
can be specified to query only a specific type(class_id) of children.
|
|
2072
|
+
Arguments can also be specified to query only direct children or the entire
|
|
2073
|
+
hierarchy of children.</p>
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
</div>
|
|
2077
|
+
</div>
|
|
2078
|
+
<div class="tags">
|
|
2079
|
+
|
|
2080
|
+
<div class="examples">
|
|
2081
|
+
<p class="tag_title">Examples:</p>
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
<pre class="example code"><code><span class='id identifier rubyid_mo_list'>mo_list</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_children'>query_children</span><span class='lparen'>(</span><span class='label'>in_mo:</span> <span class='id identifier rubyid_mo'>mo</span><span class='rparen'>)</span></code></pre>
|
|
2085
|
+
|
|
2086
|
+
|
|
2087
|
+
<pre class="example code"><code><span class='id identifier rubyid_mo_list'>mo_list</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_children'>query_children</span><span class='lparen'>(</span><span class='label'>in_mo:</span> <span class='id identifier rubyid_mo'>mo</span><span class='comma'>,</span> <span class='label'>class_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>classid</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
<pre class="example code"><code><span class='id identifier rubyid_mo_list'>mo_list</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_children'>query_children</span><span class='lparen'>(</span><span class='label'>in_dn:</span> <span class='id identifier rubyid_dn'>dn</span><span class='rparen'>)</span></code></pre>
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
<pre class="example code"><code><span class='id identifier rubyid_mo_list'>mo_list</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_children'>query_children</span><span class='lparen'>(</span><span class='label'>in_dn:</span> <span class='id identifier rubyid_dn'>dn</span><span class='comma'>,</span> <span class='label'>class_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>classid</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
2094
|
+
|
|
2095
|
+
</div>
|
|
2096
|
+
<p class="tag_title">Parameters:</p>
|
|
2097
|
+
<ul class="param">
|
|
2098
|
+
|
|
2099
|
+
<li>
|
|
2100
|
+
|
|
2101
|
+
<span class='name'>in_mo</span>
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
<span class='type'>(<tt>ManagedObject</tt>)</span>
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
—
|
|
2109
|
+
<div class='inline'>
|
|
2110
|
+
<p>query children managed object under this object.</p>
|
|
2111
|
+
</div>
|
|
2112
|
+
|
|
2113
|
+
</li>
|
|
2114
|
+
|
|
2115
|
+
<li>
|
|
2116
|
+
|
|
2117
|
+
<span class='name'>in_dn</span>
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
—
|
|
2125
|
+
<div class='inline'>
|
|
2126
|
+
<p>query children managed object for a given managed object of the respective
|
|
2127
|
+
dn.</p>
|
|
2128
|
+
</div>
|
|
2129
|
+
|
|
2130
|
+
</li>
|
|
2131
|
+
|
|
2132
|
+
<li>
|
|
2133
|
+
|
|
2134
|
+
<span class='name'>class_id</span>
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
—
|
|
2142
|
+
<div class='inline'>
|
|
2143
|
+
<p>by default nil, if given finds only specific childred object for a given
|
|
2144
|
+
class_id.</p>
|
|
2145
|
+
</div>
|
|
2146
|
+
|
|
2147
|
+
</li>
|
|
2148
|
+
|
|
2149
|
+
<li>
|
|
2150
|
+
|
|
2151
|
+
<span class='name'>hierarchy</span>
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
2155
|
+
|
|
2156
|
+
|
|
2157
|
+
|
|
2158
|
+
—
|
|
2159
|
+
<div class='inline'>
|
|
2160
|
+
<p>if set to true will return all the child hierarchical objects.</p>
|
|
2161
|
+
</div>
|
|
2162
|
+
|
|
2163
|
+
</li>
|
|
2164
|
+
|
|
2165
|
+
<li>
|
|
2166
|
+
|
|
2167
|
+
<span class='name'>timeout</span>
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
—
|
|
2175
|
+
<div class='inline'>
|
|
2176
|
+
<p>timeout value in seconds</p>
|
|
2177
|
+
</div>
|
|
2178
|
+
|
|
2179
|
+
</li>
|
|
2180
|
+
|
|
2181
|
+
</ul>
|
|
2182
|
+
|
|
2183
|
+
<p class="tag_title">Returns:</p>
|
|
2184
|
+
<ul class="return">
|
|
2185
|
+
|
|
2186
|
+
<li>
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
<span class='type'>(<tt>Array<ManagedObject></tt>, <tt>nil</tt>)</span>
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
</li>
|
|
2194
|
+
|
|
2195
|
+
</ul>
|
|
2196
|
+
|
|
2197
|
+
</div><table class="source_code">
|
|
2198
|
+
<tr>
|
|
2199
|
+
<td>
|
|
2200
|
+
<pre class="lines">
|
|
2201
|
+
|
|
2202
|
+
|
|
2203
|
+
261
|
|
2204
|
+
262
|
|
2205
|
+
263
|
|
2206
|
+
264
|
|
2207
|
+
265
|
|
2208
|
+
266
|
|
2209
|
+
267
|
|
2210
|
+
268
|
|
2211
|
+
269
|
|
2212
|
+
270
|
|
2213
|
+
271
|
|
2214
|
+
272
|
|
2215
|
+
273
|
|
2216
|
+
274
|
|
2217
|
+
275
|
|
2218
|
+
276
|
|
2219
|
+
277
|
|
2220
|
+
278
|
|
2221
|
+
279
|
|
2222
|
+
280
|
|
2223
|
+
281
|
|
2224
|
+
282
|
|
2225
|
+
283
|
|
2226
|
+
284
|
|
2227
|
+
285
|
|
2228
|
+
286
|
|
2229
|
+
287
|
|
2230
|
+
288
|
|
2231
|
+
289
|
|
2232
|
+
290
|
|
2233
|
+
291
|
|
2234
|
+
292</pre>
|
|
2235
|
+
</td>
|
|
2236
|
+
<td>
|
|
2237
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 261</span>
|
|
2238
|
+
|
|
2239
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_query_children'>query_children</span><span class='lparen'>(</span><span class='label'>in_mo:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>in_dn:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>class_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2240
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_in_mo'>in_mo</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='kw'>and</span> <span class='id identifier rubyid_in_dn'>in_dn</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2241
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ValueError</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[Error]: GetChild: Provide in_mo or in_dn</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2242
|
+
<span class='kw'>end</span>
|
|
2243
|
+
|
|
2244
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_in_mo'>in_mo</span>
|
|
2245
|
+
<span class='id identifier rubyid_parent_dn'>parent_dn</span> <span class='op'>=</span> <span class='id identifier rubyid_in_mo'>in_mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span>
|
|
2246
|
+
<span class='kw'>elsif</span>
|
|
2247
|
+
<span class='id identifier rubyid_parent_dn'>parent_dn</span> <span class='op'>=</span> <span class='id identifier rubyid_in_dn'>in_dn</span>
|
|
2248
|
+
<span class='kw'>end</span>
|
|
2249
|
+
|
|
2250
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_class_id'>class_id</span>
|
|
2251
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_find_class_id_in_mo_meta_ignore_case'>find_class_id_in_mo_meta_ignore_case</span><span class='lparen'>(</span><span class='id identifier rubyid_class_id'>class_id</span><span class='rparen'>)</span>
|
|
2252
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_meta_class_id'>meta_class_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2253
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_class_id'>class_id</span>
|
|
2254
|
+
<span class='kw'>end</span>
|
|
2255
|
+
<span class='kw'>else</span>
|
|
2256
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_class_id'>class_id</span>
|
|
2257
|
+
<span class='kw'>end</span>
|
|
2258
|
+
|
|
2259
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_config_resolve_children'>config_resolve_children</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span> <span class='id identifier rubyid_class_id'>class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_meta_class_id'>meta_class_id</span><span class='comma'>,</span> <span class='id identifier rubyid_in_dn'>in_dn</span> <span class='op'>=</span> <span class='id identifier rubyid_parent_dn'>parent_dn</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
2260
|
+
|
|
2261
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
2262
|
+
|
|
2263
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
2264
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
2265
|
+
<span class='kw'>end</span>
|
|
2266
|
+
|
|
2267
|
+
<span class='id identifier rubyid_out_mo_list'>out_mo_list</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_extract_molist_from_method_response'>extract_molist_from_method_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
2268
|
+
|
|
2269
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_out_mo_list'>out_mo_list</span>
|
|
2270
|
+
<span class='kw'>end</span></pre>
|
|
2271
|
+
</td>
|
|
2272
|
+
</tr>
|
|
2273
|
+
</table>
|
|
2274
|
+
</div>
|
|
2275
|
+
|
|
2276
|
+
<div class="method_details ">
|
|
2277
|
+
<h3 class="signature " id="query_classid-instance_method">
|
|
2278
|
+
|
|
2279
|
+
#<strong>query_classid</strong>(class_id:, hierarchy: false, need_response: false, timeout: "60") ⇒ <tt>Array<ManagedObject></tt>, ...
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
|
|
2283
|
+
|
|
2284
|
+
|
|
2285
|
+
</h3><div class="docstring">
|
|
2286
|
+
<div class="discussion">
|
|
2287
|
+
|
|
2288
|
+
<p>Finds an object using it's class id.</p>
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
</div>
|
|
2292
|
+
</div>
|
|
2293
|
+
<div class="tags">
|
|
2294
|
+
|
|
2295
|
+
<div class="examples">
|
|
2296
|
+
<p class="tag_title">Examples:</p>
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
<pre class="example code"><code><span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>computeRackUnit</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
<pre class="example code"><code><span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>computeRackUnit</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>true</span><span class='rparen'>)</span></code></pre>
|
|
2303
|
+
|
|
2304
|
+
|
|
2305
|
+
<pre class="example code"><code><span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>computeRackUnit</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>need_response:</span> <span class='kw'>true</span><span class='rparen'>)</span></code></pre>
|
|
2306
|
+
|
|
2307
|
+
</div>
|
|
2308
|
+
<p class="tag_title">Parameters:</p>
|
|
2309
|
+
<ul class="param">
|
|
2310
|
+
|
|
2311
|
+
<li>
|
|
2312
|
+
|
|
2313
|
+
<span class='name'>class_id</span>
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
—
|
|
2321
|
+
<div class='inline'>
|
|
2322
|
+
<p>class id of the object to be queried for.</p>
|
|
2323
|
+
</div>
|
|
2324
|
+
|
|
2325
|
+
</li>
|
|
2326
|
+
|
|
2327
|
+
<li>
|
|
2328
|
+
|
|
2329
|
+
<span class='name'>hierarchy</span>
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
—
|
|
2337
|
+
<div class='inline'>
|
|
2338
|
+
<p>if set to true will return all the child hierarchical objects.</p>
|
|
2339
|
+
</div>
|
|
2340
|
+
|
|
2341
|
+
</li>
|
|
2342
|
+
|
|
2343
|
+
<li>
|
|
2344
|
+
|
|
2345
|
+
<span class='name'>need_response</span>
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
|
|
2352
|
+
—
|
|
2353
|
+
<div class='inline'>
|
|
2354
|
+
<p>if set to true will return only response object.</p>
|
|
2355
|
+
</div>
|
|
2356
|
+
|
|
2357
|
+
</li>
|
|
2358
|
+
|
|
2359
|
+
<li>
|
|
2360
|
+
|
|
2361
|
+
<span class='name'>timeout</span>
|
|
2362
|
+
|
|
2363
|
+
|
|
2364
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
—
|
|
2369
|
+
<div class='inline'>
|
|
2370
|
+
<p>timeout value(in seconds)</p>
|
|
2371
|
+
</div>
|
|
2372
|
+
|
|
2373
|
+
</li>
|
|
2374
|
+
|
|
2375
|
+
</ul>
|
|
2376
|
+
|
|
2377
|
+
<p class="tag_title">Returns:</p>
|
|
2378
|
+
<ul class="return">
|
|
2379
|
+
|
|
2380
|
+
<li>
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
<span class='type'>(<tt>Array<ManagedObject></tt>, <tt>Method_Response</tt>, <tt>nil</tt>)</span>
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
—
|
|
2388
|
+
<div class='inline'>
|
|
2389
|
+
<p>returns Method_Response if need_response is set to true</p>
|
|
2390
|
+
</div>
|
|
2391
|
+
|
|
2392
|
+
</li>
|
|
2393
|
+
|
|
2394
|
+
</ul>
|
|
2395
|
+
|
|
2396
|
+
</div><table class="source_code">
|
|
2397
|
+
<tr>
|
|
2398
|
+
<td>
|
|
2399
|
+
<pre class="lines">
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
211
|
|
2403
|
+
212
|
|
2404
|
+
213
|
|
2405
|
+
214
|
|
2406
|
+
215
|
|
2407
|
+
216
|
|
2408
|
+
217
|
|
2409
|
+
218
|
|
2410
|
+
219
|
|
2411
|
+
220
|
|
2412
|
+
221
|
|
2413
|
+
222
|
|
2414
|
+
223
|
|
2415
|
+
224
|
|
2416
|
+
225
|
|
2417
|
+
226
|
|
2418
|
+
227
|
|
2419
|
+
228
|
|
2420
|
+
229
|
|
2421
|
+
230
|
|
2422
|
+
231
|
|
2423
|
+
232
|
|
2424
|
+
233
|
|
2425
|
+
234
|
|
2426
|
+
235
|
|
2427
|
+
236
|
|
2428
|
+
237
|
|
2429
|
+
238</pre>
|
|
2430
|
+
</td>
|
|
2431
|
+
<td>
|
|
2432
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 211</span>
|
|
2433
|
+
|
|
2434
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_query_classid'>query_classid</span><span class='lparen'>(</span><span class='label'>class_id:</span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>need_response:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
|
|
2435
|
+
|
|
2436
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_class_id'>class_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2437
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ValueError</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Provide Parameter class_id</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2438
|
+
<span class='kw'>end</span>
|
|
2439
|
+
|
|
2440
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_find_class_id_in_mo_meta_ignore_case'>find_class_id_in_mo_meta_ignore_case</span><span class='lparen'>(</span><span class='id identifier rubyid_class_id'>class_id</span><span class='rparen'>)</span>
|
|
2441
|
+
|
|
2442
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_meta_class_id'>meta_class_id</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2443
|
+
<span class='id identifier rubyid_meta_class_id'>meta_class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_class_id'>class_id</span>
|
|
2444
|
+
<span class='kw'>end</span>
|
|
2445
|
+
|
|
2446
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_config_resolve_class'>config_resolve_class</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span> <span class='id identifier rubyid_class_id'>class_id</span> <span class='op'>=</span> <span class='id identifier rubyid_meta_class_id'>meta_class_id</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
2447
|
+
|
|
2448
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
2449
|
+
|
|
2450
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
2451
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
2452
|
+
<span class='kw'>end</span>
|
|
2453
|
+
|
|
2454
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_need_response'>need_response</span>
|
|
2455
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
|
|
2456
|
+
<span class='kw'>end</span>
|
|
2457
|
+
|
|
2458
|
+
<span class='id identifier rubyid_out_mo_list'>out_mo_list</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_extract_molist_from_method_response'>extract_molist_from_method_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
2459
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_out_mo_list'>out_mo_list</span>
|
|
2460
|
+
|
|
2461
|
+
<span class='kw'>end</span></pre>
|
|
2462
|
+
</td>
|
|
2463
|
+
</tr>
|
|
2464
|
+
</table>
|
|
2465
|
+
</div>
|
|
2466
|
+
|
|
2467
|
+
<div class="method_details ">
|
|
2468
|
+
<h3 class="signature " id="query_dn-instance_method">
|
|
2469
|
+
|
|
2470
|
+
#<strong>query_dn</strong>(dn:, hierarchy: false, need_response: false, timeout: "60") ⇒ <tt>ManagedObject</tt>, ...
|
|
2471
|
+
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
</h3><div class="docstring">
|
|
2477
|
+
<div class="discussion">
|
|
2478
|
+
|
|
2479
|
+
<p>Finds an object using it's distinguished name.</p>
|
|
2480
|
+
|
|
2481
|
+
<p>returns ExternalMethod if need_response is set to true.</p>
|
|
2482
|
+
|
|
2483
|
+
|
|
2484
|
+
</div>
|
|
2485
|
+
</div>
|
|
2486
|
+
<div class="tags">
|
|
2487
|
+
|
|
2488
|
+
<div class="examples">
|
|
2489
|
+
<p class="tag_title">Examples:</p>
|
|
2490
|
+
|
|
2491
|
+
|
|
2492
|
+
<pre class="example code"><code><span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_dn'>query_dn</span><span class='lparen'>(</span><span class='label'>dn:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sys/rack-unit-1</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span></code></pre>
|
|
2493
|
+
|
|
2494
|
+
|
|
2495
|
+
<pre class="example code"><code><span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_dn'>query_dn</span><span class='lparen'>(</span><span class='label'>dn:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sys/rack-unit-1</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>true</span><span class='rparen'>)</span></code></pre>
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
<pre class="example code"><code>obj = handle.query_dn(dn: "sys/rack-unit-1", need_response: true</code></pre>
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
<pre class="example code"><code><span class='id identifier rubyid_obj'>obj</span> <span class='op'>=</span> <span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_query_dn'>query_dn</span><span class='lparen'>(</span><span class='label'>dn:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sys/rack-unit-1</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>need_response:</span> <span class='kw'>true</span><span class='rparen'>)</span></code></pre>
|
|
2502
|
+
|
|
2503
|
+
</div>
|
|
2504
|
+
<p class="tag_title">Parameters:</p>
|
|
2505
|
+
<ul class="param">
|
|
2506
|
+
|
|
2507
|
+
<li>
|
|
2508
|
+
|
|
2509
|
+
<span class='name'>dn</span>
|
|
2510
|
+
|
|
2511
|
+
|
|
2512
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
|
|
2516
|
+
—
|
|
2517
|
+
<div class='inline'>
|
|
2518
|
+
<p>distinguished name of the object to be queried for.</p>
|
|
2519
|
+
</div>
|
|
2520
|
+
|
|
2521
|
+
</li>
|
|
2522
|
+
|
|
2523
|
+
<li>
|
|
2524
|
+
|
|
2525
|
+
<span class='name'>hierarchy</span>
|
|
2526
|
+
|
|
2527
|
+
|
|
2528
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
2529
|
+
|
|
2530
|
+
|
|
2531
|
+
|
|
2532
|
+
—
|
|
2533
|
+
<div class='inline'>
|
|
2534
|
+
<p>Gets all objects in hierarchy if true</p>
|
|
2535
|
+
</div>
|
|
2536
|
+
|
|
2537
|
+
</li>
|
|
2538
|
+
|
|
2539
|
+
<li>
|
|
2540
|
+
|
|
2541
|
+
<span class='name'>need_response</span>
|
|
2542
|
+
|
|
2543
|
+
|
|
2544
|
+
<span class='type'>(<tt>TrueClass</tt>, <tt>FalseClass</tt>)</span>
|
|
2545
|
+
|
|
2546
|
+
|
|
2547
|
+
|
|
2548
|
+
—
|
|
2549
|
+
<div class='inline'>
|
|
2550
|
+
<p>returns the response xml node, instead of parsed objects.</p>
|
|
2551
|
+
</div>
|
|
2552
|
+
|
|
2553
|
+
</li>
|
|
2554
|
+
|
|
2555
|
+
<li>
|
|
2556
|
+
|
|
2557
|
+
<span class='name'>timeout</span>
|
|
2558
|
+
|
|
2559
|
+
|
|
2560
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2561
|
+
|
|
2562
|
+
|
|
2563
|
+
|
|
2564
|
+
—
|
|
2565
|
+
<div class='inline'>
|
|
2566
|
+
<p>timeout value(in seconds)</p>
|
|
2567
|
+
</div>
|
|
2568
|
+
|
|
2569
|
+
</li>
|
|
2570
|
+
|
|
2571
|
+
</ul>
|
|
2572
|
+
|
|
2573
|
+
<p class="tag_title">Returns:</p>
|
|
2574
|
+
<ul class="return">
|
|
2575
|
+
|
|
2576
|
+
<li>
|
|
2577
|
+
|
|
2578
|
+
|
|
2579
|
+
<span class='type'>(<tt>ManagedObject</tt>, <tt>Array<ManagedObject></tt>, <tt>ExternalMethod</tt>)</span>
|
|
2580
|
+
|
|
2581
|
+
|
|
2582
|
+
|
|
2583
|
+
—
|
|
2584
|
+
<div class='inline'>
|
|
2585
|
+
<p>Return Managed Object by default, returns Array<ManagedObject> if
|
|
2586
|
+
hierarchy is set to true,</p>
|
|
2587
|
+
</div>
|
|
2588
|
+
|
|
2589
|
+
</li>
|
|
2590
|
+
|
|
2591
|
+
</ul>
|
|
2592
|
+
|
|
2593
|
+
</div><table class="source_code">
|
|
2594
|
+
<tr>
|
|
2595
|
+
<td>
|
|
2596
|
+
<pre class="lines">
|
|
2597
|
+
|
|
2598
|
+
|
|
2599
|
+
164
|
|
2600
|
+
165
|
|
2601
|
+
166
|
|
2602
|
+
167
|
|
2603
|
+
168
|
|
2604
|
+
169
|
|
2605
|
+
170
|
|
2606
|
+
171
|
|
2607
|
+
172
|
|
2608
|
+
173
|
|
2609
|
+
174
|
|
2610
|
+
175
|
|
2611
|
+
176
|
|
2612
|
+
177
|
|
2613
|
+
178
|
|
2614
|
+
179
|
|
2615
|
+
180
|
|
2616
|
+
181
|
|
2617
|
+
182
|
|
2618
|
+
183
|
|
2619
|
+
184
|
|
2620
|
+
185
|
|
2621
|
+
186
|
|
2622
|
+
187
|
|
2623
|
+
188
|
|
2624
|
+
189
|
|
2625
|
+
190
|
|
2626
|
+
191
|
|
2627
|
+
192
|
|
2628
|
+
193</pre>
|
|
2629
|
+
</td>
|
|
2630
|
+
<td>
|
|
2631
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 164</span>
|
|
2632
|
+
|
|
2633
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_query_dn'>query_dn</span><span class='lparen'>(</span><span class='label'>dn:</span><span class='comma'>,</span> <span class='label'>hierarchy:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>need_response:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2634
|
+
|
|
2635
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_dn'>dn</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2636
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ValueError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Provide dn.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2637
|
+
<span class='kw'>end</span>
|
|
2638
|
+
|
|
2639
|
+
<span class='id identifier rubyid_elem'>elem</span> <span class='op'>=</span> <span class='id identifier rubyid_config_resolve_dn'>config_resolve_dn</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_cookie'>cookie</span><span class='comma'>,</span> <span class='id identifier rubyid_dn'>dn</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
2640
|
+
|
|
2641
|
+
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_post_elem'>post_elem</span><span class='lparen'>(</span><span class='id identifier rubyid_elem'>elem</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
2642
|
+
|
|
2643
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span> <span class='op'>!=</span> <span class='int'>0</span>
|
|
2644
|
+
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ImcException</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_code'>error_code</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_error_descr'>error_descr</span><span class='rparen'>)</span>
|
|
2645
|
+
<span class='kw'>end</span>
|
|
2646
|
+
|
|
2647
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_need_response'>need_response</span>
|
|
2648
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_response'>response</span>
|
|
2649
|
+
<span class='kw'>end</span>
|
|
2650
|
+
|
|
2651
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span>
|
|
2652
|
+
<span class='id identifier rubyid_out_mo_list'>out_mo_list</span> <span class='op'>=</span> <span class='const'>ImcCoreUtils</span><span class='period'>.</span><span class='id identifier rubyid_extract_molist_from_method_response'>extract_molist_from_method_response</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='comma'>,</span> <span class='id identifier rubyid_hierarchy'>hierarchy</span><span class='rparen'>)</span>
|
|
2653
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_out_mo_list'>out_mo_list</span>
|
|
2654
|
+
<span class='kw'>end</span>
|
|
2655
|
+
|
|
2656
|
+
<span class='id identifier rubyid_mo'>mo</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
2657
|
+
<span class='id identifier rubyid_child'>child</span> <span class='op'>=</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_get_outconfig_child'>get_outconfig_child</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
2658
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_child'>child</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='op'>></span> <span class='int'>0</span>
|
|
2659
|
+
<span class='id identifier rubyid_mo'>mo</span> <span class='op'>=</span> <span class='id identifier rubyid_child'>child</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
|
|
2660
|
+
<span class='kw'>end</span>
|
|
2661
|
+
<span class='kw'>return</span> <span class='id identifier rubyid_mo'>mo</span>
|
|
2662
|
+
<span class='kw'>end</span></pre>
|
|
2663
|
+
</td>
|
|
2664
|
+
</tr>
|
|
2665
|
+
</table>
|
|
2666
|
+
</div>
|
|
2667
|
+
|
|
2668
|
+
<div class="method_details ">
|
|
2669
|
+
<h3 class="signature " id="remove_mo-instance_method">
|
|
2670
|
+
|
|
2671
|
+
#<strong>remove_mo</strong>(mo:, timeout: "60") ⇒ <tt>nil</tt>
|
|
2672
|
+
|
|
2673
|
+
|
|
2674
|
+
|
|
2675
|
+
|
|
2676
|
+
|
|
2677
|
+
</h3><div class="docstring">
|
|
2678
|
+
<div class="discussion">
|
|
2679
|
+
|
|
2680
|
+
<p>Remove a Managed Object from the IMC Server</p>
|
|
2681
|
+
|
|
2682
|
+
|
|
2683
|
+
</div>
|
|
2684
|
+
</div>
|
|
2685
|
+
<div class="tags">
|
|
2686
|
+
|
|
2687
|
+
<div class="examples">
|
|
2688
|
+
<p class="tag_title">Examples:</p>
|
|
2689
|
+
|
|
2690
|
+
|
|
2691
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_remove_mo'>remove_mo</span><span class='lparen'>(</span><span class='label'>mo:</span> <span class='id identifier rubyid_mo'>mo</span><span class='rparen'>)</span></code></pre>
|
|
2692
|
+
|
|
2693
|
+
</div>
|
|
2694
|
+
<p class="tag_title">Parameters:</p>
|
|
2695
|
+
<ul class="param">
|
|
2696
|
+
|
|
2697
|
+
<li>
|
|
2698
|
+
|
|
2699
|
+
<span class='name'>mo</span>
|
|
2700
|
+
|
|
2701
|
+
|
|
2702
|
+
<span class='type'>(<tt>ManagedObject</tt>)</span>
|
|
2703
|
+
|
|
2704
|
+
|
|
2705
|
+
|
|
2706
|
+
—
|
|
2707
|
+
<div class='inline'>
|
|
2708
|
+
<p>Managed Object to be removed.</p>
|
|
2709
|
+
</div>
|
|
2710
|
+
|
|
2711
|
+
</li>
|
|
2712
|
+
|
|
2713
|
+
<li>
|
|
2714
|
+
|
|
2715
|
+
<span class='name'>timeout</span>
|
|
2716
|
+
|
|
2717
|
+
|
|
2718
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
2719
|
+
|
|
2720
|
+
|
|
2721
|
+
|
|
2722
|
+
—
|
|
2723
|
+
<div class='inline'>
|
|
2724
|
+
<p>timeout value(in seconds).</p>
|
|
2725
|
+
</div>
|
|
2726
|
+
|
|
2727
|
+
</li>
|
|
2728
|
+
|
|
2729
|
+
</ul>
|
|
2730
|
+
|
|
2731
|
+
<p class="tag_title">Returns:</p>
|
|
2732
|
+
<ul class="return">
|
|
2733
|
+
|
|
2734
|
+
<li>
|
|
2735
|
+
|
|
2736
|
+
|
|
2737
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
2738
|
+
|
|
2739
|
+
|
|
2740
|
+
|
|
2741
|
+
—
|
|
2742
|
+
<div class='inline'>
|
|
2743
|
+
<p>Nothing is returned.</p>
|
|
2744
|
+
</div>
|
|
2745
|
+
|
|
2746
|
+
</li>
|
|
2747
|
+
|
|
2748
|
+
</ul>
|
|
2749
|
+
|
|
2750
|
+
</div><table class="source_code">
|
|
2751
|
+
<tr>
|
|
2752
|
+
<td>
|
|
2753
|
+
<pre class="lines">
|
|
2754
|
+
|
|
2755
|
+
|
|
2756
|
+
345
|
|
2757
|
+
346
|
|
2758
|
+
347
|
|
2759
|
+
348
|
|
2760
|
+
349
|
|
2761
|
+
350
|
|
2762
|
+
351
|
|
2763
|
+
352
|
|
2764
|
+
353</pre>
|
|
2765
|
+
</td>
|
|
2766
|
+
<td>
|
|
2767
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 345</span>
|
|
2768
|
+
|
|
2769
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_remove_mo'>remove_mo</span><span class='lparen'>(</span><span class='label'>mo:</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2770
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>deleted</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2771
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_defined?'>instance_variable_defined?</span><span class='lparen'>(</span><span class='symbol'>:@parent_mo</span><span class='rparen'>)</span> <span class='kw'>and</span> <span class='op'>!</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_parent_mo'>parent_mo</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2772
|
+
<span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_parent_mo'>parent_mo</span><span class='period'>.</span><span class='id identifier rubyid_child_remove'>child_remove</span><span class='lparen'>(</span><span class='id identifier rubyid_mo'>mo</span><span class='rparen'>)</span>
|
|
2773
|
+
<span class='kw'>end</span>
|
|
2774
|
+
|
|
2775
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span><span class='lbracket'>[</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_dn'>dn</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mo'>mo</span>
|
|
2776
|
+
<span class='id identifier rubyid__commit'>_commit</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
2777
|
+
<span class='kw'>end</span></pre>
|
|
2778
|
+
</td>
|
|
2779
|
+
</tr>
|
|
2780
|
+
</table>
|
|
2781
|
+
</div>
|
|
2782
|
+
|
|
2783
|
+
<div class="method_details ">
|
|
2784
|
+
<h3 class="signature " id="set_mo-instance_method">
|
|
2785
|
+
|
|
2786
|
+
#<strong>set_mo</strong>(mo:, timeout: "60") ⇒ <tt>nil</tt>
|
|
2787
|
+
|
|
2788
|
+
|
|
2789
|
+
|
|
2790
|
+
|
|
2791
|
+
|
|
2792
|
+
</h3><div class="docstring">
|
|
2793
|
+
<div class="discussion">
|
|
2794
|
+
|
|
2795
|
+
<p>Modifies a managed object and adds it to the ImcHandle commit buffer (if
|
|
2796
|
+
not already in it)</p>
|
|
2797
|
+
|
|
2798
|
+
|
|
2799
|
+
</div>
|
|
2800
|
+
</div>
|
|
2801
|
+
<div class="tags">
|
|
2802
|
+
|
|
2803
|
+
<div class="examples">
|
|
2804
|
+
<p class="tag_title">Examples:</p>
|
|
2805
|
+
|
|
2806
|
+
|
|
2807
|
+
<pre class="example code"><code><span class='id identifier rubyid_handle'>handle</span><span class='period'>.</span><span class='id identifier rubyid_set_mo'>set_mo</span><span class='lparen'>(</span><span class='label'>mo:</span> <span class='id identifier rubyid_mo'>mo</span><span class='rparen'>)</span></code></pre>
|
|
2808
|
+
|
|
2809
|
+
</div>
|
|
2810
|
+
<p class="tag_title">Parameters:</p>
|
|
2811
|
+
<ul class="param">
|
|
2812
|
+
|
|
2813
|
+
<li>
|
|
2814
|
+
|
|
2815
|
+
<span class='name'>mo</span>
|
|
2816
|
+
|
|
2817
|
+
|
|
2818
|
+
<span class='type'>(<tt>ManagedObject</tt>)</span>
|
|
2819
|
+
|
|
2820
|
+
|
|
2821
|
+
|
|
2822
|
+
—
|
|
2823
|
+
<div class='inline'>
|
|
2824
|
+
<p>Managed Object with modified properties</p>
|
|
2825
|
+
</div>
|
|
2826
|
+
|
|
2827
|
+
</li>
|
|
2828
|
+
|
|
2829
|
+
<li>
|
|
2830
|
+
|
|
2831
|
+
<span class='name'>timeout</span>
|
|
2832
|
+
|
|
2833
|
+
|
|
2834
|
+
<span class='type'>(<tt>Integer</tt>, <tt>nil</tt>)</span>
|
|
2835
|
+
|
|
2836
|
+
|
|
2837
|
+
|
|
2838
|
+
—
|
|
2839
|
+
<div class='inline'>
|
|
2840
|
+
<p>timeout value in seconds</p>
|
|
2841
|
+
</div>
|
|
2842
|
+
|
|
2843
|
+
</li>
|
|
2844
|
+
|
|
2845
|
+
</ul>
|
|
2846
|
+
|
|
2847
|
+
<p class="tag_title">Returns:</p>
|
|
2848
|
+
<ul class="return">
|
|
2849
|
+
|
|
2850
|
+
<li>
|
|
2851
|
+
|
|
2852
|
+
|
|
2853
|
+
<span class='type'>(<tt>nil</tt>)</span>
|
|
2854
|
+
|
|
2855
|
+
|
|
2856
|
+
|
|
2857
|
+
</li>
|
|
2858
|
+
|
|
2859
|
+
</ul>
|
|
2860
|
+
|
|
2861
|
+
</div><table class="source_code">
|
|
2862
|
+
<tr>
|
|
2863
|
+
<td>
|
|
2864
|
+
<pre class="lines">
|
|
2865
|
+
|
|
2866
|
+
|
|
2867
|
+
328
|
|
2868
|
+
329
|
|
2869
|
+
330
|
|
2870
|
+
331
|
|
2871
|
+
332
|
|
2872
|
+
333</pre>
|
|
2873
|
+
</td>
|
|
2874
|
+
<td>
|
|
2875
|
+
<pre class="code"><span class="info file"># File 'lib/ImcSdk.rb', line 328</span>
|
|
2876
|
+
|
|
2877
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_set_mo'>set_mo</span><span class='lparen'>(</span><span class='label'>mo:</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>60</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2878
|
+
<span class='comment'>#mo.instance_variable_set(:@status, "modified")
|
|
2879
|
+
</span> <span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_set_prop'>set_prop</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>status</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>modified</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2880
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_to_commit'>to_commit</span><span class='lbracket'>[</span><span class='id identifier rubyid_mo'>mo</span><span class='period'>.</span><span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:@dn</span><span class='rparen'>)</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mo'>mo</span>
|
|
2881
|
+
<span class='id identifier rubyid__commit'>_commit</span><span class='lparen'>(</span><span class='label'>timeout:</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
|
|
2882
|
+
<span class='kw'>end</span></pre>
|
|
2883
|
+
</td>
|
|
2884
|
+
</tr>
|
|
2885
|
+
</table>
|
|
2886
|
+
</div>
|
|
2887
|
+
|
|
2888
|
+
</div>
|
|
2889
|
+
|
|
2890
|
+
</div>
|
|
2891
|
+
|
|
2892
|
+
<div id="footer">
|
|
2893
|
+
Generated on Wed Jun 7 14:23:17 2017 by
|
|
2894
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2895
|
+
0.9.9 (ruby-2.3.1).
|
|
2896
|
+
</div>
|
|
2897
|
+
|
|
2898
|
+
</div>
|
|
2899
|
+
</body>
|
|
2900
|
+
</html>
|