search cancel

List of Spectrum Relation Handles to be used in REST API or CLI

book

Article ID: 200730

calendar_today

Updated On:

Products

CA Spectrum DX NetOps

Issue/Introduction

Users may want to view, add, remove or modify model associations within Spectrum using CLI or REST API. Below is a complete list of the relationship handles that can be used.

Environment

Release: Spectrum 20.2.x

Component: SPCAPP - Spectrum Applications

Resolution

Name Relation_ID Type
Contains 0×10001 ONE_TO_MANY
Collects 0×10002 ONE_TO_MANY
Encompasses 0×10003 MANY_TO_MANY
HASPART 0×10004 MANY_TO_MANY
Connects_to 0×10005 MANY_TO_MANY
Executes 0×10006 MANY_TO_MANY
Is_Adjacent_to 0×10007 MANY_TO_MANY
Passes_Through 0×10008 MANY_TO_MANY
Monitors 0x1000c MANY_TO_MANY
Lost_and_Found 0×10010 ONE_TO_MANY
File_Server 0×10011 MANY_TO_MANY
Print_Server 0×10012 MANY_TO_MANY
Application 0×10013 MANY_TO_MANY
Mail_Server 0×10014 MANY_TO_MANY
Other_Server 0×10015 MANY_TO_MANY
Organizes 0×10016 MANY_TO_MANY
Owns 0×10018 MANY_TO_MANY
PolyMorph 0x1001a ONE_TO_MANY
Can_Assign 0x1001b ONE_TO_MANY
Is_Assigned 0x1001c MANY_TO_MANY
Indirect_Model_Of 0x1001e MANY_TO_MANY
Manages 0x1001f ONE_TO_MANY
Provides 0×10020 ONE_TO_MANY
Seems_Adjacent_to 0×10021 MANY_TO_MANY
Has_Member 0×10022 MANY_TO_MANY
Links_with 0×10023 ONE_TO_MANY
Is_Bounded_By 0×10024 ONE_TO_MANY
IsServerTo 0×10025 MANY_TO_MANY
Indirect_Adj_to 0×10026 MANY_TO_MANY
Has_Preference 0×10027 ONE_TO_MANY
CollectsChassis 0×10028 ONE_TO_MANY
Sub_If_Links_With 0×10029 MANY_TO_MANY
Creates_Sub_Ifs_For 0x1002a MANY_TO_MANY
HasViewedComponent 0x1002d ONE_TO_MANY
Is_Management_Neighbor_For 0x1002e MANY_TO_MANY
Applies_to 0x1002f ONE_TO_MANY
Is_EventAdmin_For 0×10030 ONE_TO_MANY
UserRole 0×10031 MANY_TO_MANY
MAINT_SCHEDULE 0×10034 MANY_TO_MANY
HasUserRole 0×10037 MANY_TO_MANY
CORRELATES 0×10038 MANY_TO_MANY
dynamicGlobalCollects 0x1003a MANY_TO_MANY
staticGlobalCollects 0x1003b MANY_TO_MANY
HasPrivilegeRole 0x1003c MANY_TO_MANY
HasAccessGroup 0x1003d MANY_TO_MANY
Groups_Customers 0x1003e MANY_TO_MANY
ProvidesLicenseRole 0x1003f ONE_TO_MANY
HasEhealthMap 0×10042 MANY_TO_MANY
HIBERNATE_AFTER_MAINT 0×10043 MANY_TO_MANY
Persistent_Lost_and_Found 0×10044 ONE_TO_MANY
CORRELATES_VISIBILITY 0×10045 MANY_TO_MANY
CONTAINS_DEVICE 0×10046 ONE_TO_MANY
HAS_DEVICE 0×10047 ONE_TO_MANY
ChassisContains 0×10048 MANY_TO_MANY
HasProxyRedirector 0×10049 ONE_TO_MANY
FaultDomainContains 0x1004a ONE_TO_MANY
GC_Schedules 0x1004b MANY_TO_MANY
hsrpHAS 0×210001 MANY_TO_MANY
PossPrimApp 0×230000 ONE_TO_MANY
USES 0×230001 ONE_TO_MANY
USING 0×230002 MANY_TO_MANY
PULLED_BOARD 0×230003 MANY_TO_MANY
CollectsConcentrator 0×230004 ONE_TO_MANY
Has_Relay_Function 0x3d0000 ONE_TO_MANY
HasHostConfig 0×820000 ONE_TO_MANY
NCM_Has_Task 0×820002 MANY_TO_MANY
NCM_Has_Task_Schedule 0×820003 MANY_TO_MANY
NCM_Family_Has_Device 0×820005 ONE_TO_MANY
NCM_Policy_Has_Violator 0×820006 MANY_TO_MANY
NCM_Has_Policy 0×820007 MANY_TO_MANY
HAS_LAST_KNOWN_CONFIG 0×820008 ONE_TO_MANY
Is_Capture_Running_Script_For 0x82000e ONE_TO_MANY
Is_Capture_Startup_Script_For 0x82000f ONE_TO_MANY
Is_Upload_Script_For 0×820010 ONE_TO_MANY
Is_Write_Startup_For 0×820011 ONE_TO_MANY
NCM_Has_Device_Family 0×820012 MANY_TO_MANY
Is_Load_FW_Script_For 0×820013 ONE_TO_MANY
Is_Reload_Script_For 0×820014 ONE_TO_MANY
Is_Cancel_Reload_Script_For 0×820015 ONE_TO_MANY
NCM_Has_Reference 0×820016 ONE_TO_MANY
NCM_Has_Repair_Task 0×820017 ONE_TO_MANY
FORESWITCHHASPART 0xaf0000 MANY_TO_MANY
hasRuleSet 0xc40001 MANY_TO_MANY
HasRPMember 0xc40003 MANY_TO_MANY
Is_Associated_With 0xd70001 ONE_TO_MANY
Has_Filters 0xd70002 ONE_TO_MANY
SANMApp_Is_Scheduled_By 0xd70003 MANY_TO_MANY
SANM_Policy_Schedule 0xd70004 MANY_TO_MANY
Phys_Contains 0×1020000 ONE_TO_MANY
Supports 0×1020001 ONE_TO_MANY
Is_Accessed_By 0×1020002 ONE_TO_MANY
Logically_Contains 0×1020003 ONE_TO_MANY
Pings_Through 0×1130001 ONE_TO_MANY
Controls 0×1770000 ONE_TO_MANY
Virtual_Links_With 0x1b80000 MANY_TO_MANY
Is_Backup_For 0x22f0000 MANY_TO_MANY
Has_Inventory 0x25e0000 ONE_TO_MANY
Discovery_Schedules 0x25e0001 MANY_TO_MANY
vLanContains 0×3390000 MANY_TO_MANY
vLanHasPort 0×3390001 MANY_TO_MANY
vLanIsBoundedBy 0×3390002 MANY_TO_MANY
vLanSpans 0×3390003 MANY_TO_MANY
vLanHasSwitchPort 0×3390004 MANY_TO_MANY
vLanPortHasUser 0×3390005 MANY_TO_MANY
vLanCollects 0×3390006 ONE_TO_MANY
agent 0×3980000 ONE_TO_MANY
g3HasArea 0x3b80000 ONE_TO_MANY
g3HasNode 0x3b80001 ONE_TO_MANY
g3Collects 0x3b80002 ONE_TO_MANY
SlmAgreesTo 0×4500000 MANY_TO_MANY
SlmGuarantees 0×4500001 MANY_TO_MANY
SlmHasGuarantee 0×4500002 ONE_TO_MANY
SlmIsMeasuredBy 0×4500003 MANY_TO_MANY
SlmMonitors 0×4500004 MANY_TO_MANY
SlmOwns 0×4500005 MANY_TO_MANY
SlmUses 0×4500006 MANY_TO_MANY
SlmWatchesContainer 0×4500007 MANY_TO_MANY
SlmContains 0×4500008 ONE_TO_MANY
SLA_Period 0×4500009 MANY_TO_MANY
SlmHasServiceComponent 0x450000a ONE_TO_MANY
SlmContainsSLAs 0x450000b ONE_TO_MANY
SlmSchedulesGuarantee 0x450000c MANY_TO_MANY
SlmProvidesTemplate 0x450000d ONE_TO_MANY
SlmHasGuaranteeTemplate 0x450000e ONE_TO_MANY
SlmHasSLAPeriod 0x450000f MANY_TO_MANY
SlmHasBusinessHours 0×4500010 MANY_TO_MANY
SlmLinkedToTemplate 0×4500011 ONE_TO_MANY
MplsTraverses 0×4520000 MANY_TO_MANY
MplsUses 0×4520001 MANY_TO_MANY
MplsManages 0×4520002 ONE_TO_MANY
MplsHasComponent 0×4520003 MANY_TO_MANY
MplsUsesDevice 0×4520004 MANY_TO_MANY
RTM_HAS_TEST 0×4560000 ONE_TO_MANY
RTM_HAS_TEST_HOST 0×4560002 ONE_TO_MANY
ACTIVE_SCHEDULE 0×4560003 MANY_TO_MANY
ACTIVE_THRESH_SCHEDULE 0×4560004 MANY_TO_MANY
RtmTemplateHasTest 0×4560005 ONE_TO_MANY
RtmTemplateHasCollection 0×4560007 MANY_TO_MANY
MulticastManages 0x47d0000 ONE_TO_MANY
MulticastServedBy 0x47d0005 MANY_TO_MANY
MulticastReceivedBy 0x47d0006 MANY_TO_MANY
MulticastUses 0x47d0007 MANY_TO_MANY
MulticastHasRP 0x47d0008 MANY_TO_MANY
MulticastUsesDevice 0x47d0009 MANY_TO_MANY
MulticastUsesApp 0x47d000c MANY_TO_MANY
MulticastUsesIf 0x47d000d MANY_TO_MANY
MulticastHasComponent 0x47d000e MANY_TO_MANY
VpnManages 0×4940000 ONE_TO_MANY
VpnUsesVpn 0×4940001 MANY_TO_MANY
VpnHasVpnSite 0×4940002 MANY_TO_MANY
VpnHasCustomerSite 0×4940003 MANY_TO_MANY
VpnUsesPE 0×4940004 MANY_TO_MANY
VpnUsesIf 0×4940005 MANY_TO_MANY
VpnUsesApp 0×4940006 MANY_TO_MANY
VpnUsesIfDirect 0×4940007 MANY_TO_MANY
VpnUsesCE 0×4940008 MANY_TO_MANY
VpnImportsRouteTarget 0x494000a MANY_TO_MANY
VpnExportsRouteTarget 0x494000b MANY_TO_MANY
HasImportedSite 0x494000c MANY_TO_MANY
VpnDiscoveredOn 0x494000d MANY_TO_MANY
SENDS_EVENTS_TO 0x4a40000 ONE_TO_MANY
HasPolicy 0x4ad0000 ONE_TO_MANY
HasPolicyRule 0x4ad0001 ONE_TO_MANY
EnforcedOn 0x4ad0002 MANY_TO_MANY
GCHasPolicyRule 0x4ad0003 MANY_TO_MANY
PolicyRuleHasSetting 0x4ad0004 MANY_TO_MANY
QosManagesPolicy 0x4b30000 ONE_TO_MANY
QosUsesClass 0x4b30001 MANY_TO_MANY
QosHasBehavior 0x4b30002 MANY_TO_MANY
QosUsesInterface 0x4b30003 MANY_TO_MANY
QosUsesDevice 0x4b30004 MANY_TO_MANY
QosUsesApp 0x4b30005 MANY_TO_MANY
HasSDConnectorHost 0x4c10002 ONE_TO_MANY
SDConnectorManages 0x4c10003 ONE_TO_MANY
TelcoContains 0x4fd0002 MANY_TO_MANY
TelcoConnects 0x4fd0003 MANY_TO_MANY
EVpnManages 0×5180000 ONE_TO_MANY
EVpnUsesProvider 0×5180001 MANY_TO_MANY
RemoteOperationsContains 0×5400000 MANY_TO_MANY
DiscoveryPolicyFor 0×5420000 MANY_TO_MANY
EhealthPolicyFor 0×5420001 ONE_TO_MANY
EHDiscHasPolicy 0×5420002 ONE_TO_MANY
HasCluster 0×5420003 ONE_TO_MANY
HasClusterMember 0×5420004 ONE_TO_MANY
HasContactServer 0×5420005 ONE_TO_MANY
HasDiscoveryPolicy 0×5420006 ONE_TO_MANY
VplsManages 0x54a0006 ONE_TO_MANY
VplsHasVpnSite 0x54a0007 MANY_TO_MANY
VplsUsesPE 0x54a0008 MANY_TO_MANY
VplsUsesIf 0x54a0009 MANY_TO_MANY
VplsUsesApp 0x54a000a MANY_TO_MANY
VplsUsesIfDirect 0x54a000b MANY_TO_MANY
HasLayer3AS 0×5640000 MANY_TO_MANY
HasLayer3Protocol 0×5640001 MANY_TO_MANY
HasLayer3Area 0×5640002 MANY_TO_MANY
HasLayer3Router 0×5640003 MANY_TO_MANY
HasLayer3LAN 0×5640004 MANY_TO_MANY
HasLayer3Link 0×5640005 MANY_TO_MANY
HasLayer3Path 0×5640006 MANY_TO_MANY
HasLayer3ECMP 0×5640007 MANY_TO_MANY
HasLayer3PathContainer 0×5640008 MANY_TO_MANY
HasIPRMChild 0×5640009 MANY_TO_MANY
HasLayer3Cloud 0x564000a ONE_TO_MANY
VirtualContains 0x56e0000 ONE_TO_MANY
VHMHasProxyRedirector 0x56e0001 ONE_TO_MANY
ManagesHost 0x56e0002 ONE_TO_MANY
HostsVirtualDevice 0x56e0003 ONE_TO_MANY
Is_Physical_Host 0x56e0004 ONE_TO_MANY
VHMContains 0x56e0005 MANY_TO_MANY
VHM_CORRELATES_RELATION 0x56e0006 ONE_TO_MANY
VHMHasPresenter 0x56e0007 ONE_TO_MANY
ManagesCiscoUCS 0x5a40000 ONE_TO_MANY
HasUCSServiceProfile 0x5a40001 ONE_TO_MANY
ADESContains 0×6060000 MANY_TO_MANY
ADESManagesTechnology 0×6060001 MANY_TO_MANY
ADESManagesForest 0×6060002 MANY_TO_MANY
ADESManagesDomain 0×6060003 MANY_TO_MANY
ADESManagesRole 0×6060004 MANY_TO_MANY
ADESManagesHost 0×6060005 MANY_TO_MANY
ADESHasProxyRedirector 0×6060006 MANY_TO_MANY
ADESManagesEntity 0×6060007 MANY_TO_MANY
ADESHasHostContainer 0×6060008 ONE_TO_MANY
ADESManagesHostDevice 0×6060009 MANY_TO_MANY
ClusterContains 0×6210000 MANY_TO_MANY
ClusterManagesTechnology 0×6210001 MANY_TO_MANY
ClusterManagesCluster 0×6210002 MANY_TO_MANY
ClusterHasProxyRedirector 0×6210003 MANY_TO_MANY
ClusterCollects 0×6210004 ONE_TO_MANY

Additional Information

Below is the documentation on how these can be used in REST API:

https://techdocs.broadcom.com/us/en/ca-enterprise-software/it-operations-management/spectrum/10-4-2/programming/web-services-api-reference/how-to-use-the-ca-spectrum-web-services-api/restful-resources-nouns/associations.html

Here is also the documentation on the CLI Commands:

https://techdocs.broadcom.com/us/en/ca-enterprise-software/it-operations-management/spectrum/10-4-2/managing-client-applications/command-line-interface/command-descriptions.html