Create Snmp Profile Parcel For System - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Create Snmp Profile Parcel For System","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/ade8dfef-05e7-3191-b6ee-a5ffe6465bd7","info":{"title":"Feature Profiles - SD-WAN System","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- System Feature Profiles in the SD-WAN Solution\n- Managing core system configurations, device management, and platform-level settings\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create a Snmp Profile Parcel for System feature profile","operationId":"CreateSnmpProfileParcelForSystem","parameters":[{"name":"systemId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Snmp Profile Parcel","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"shutdown":{"description":"Enable or disable SNMP","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"boolean","enum":[false],"$$ref":"#/components/schemas/CommonCommonDefs_booleanFalseDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfShutdownOptionsDef"},"contact":{"description":"Set the contact for this managed node","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":255,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_contactDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfContactOptionsDef"},"location":{"description":"Set the physical location of this managed node","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":255,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_locationDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfLocationOptionsDef"},"view":{"description":"Configure a view record","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Set the name of the SNMP view","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":32,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_viewNameDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewNameOptionsDef"},"oid":{"description":"Configure SNMP object identifier","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"id":{"description":"Configure identifier of subtree of MIB objects","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","pattern":"^(([0-1](\\.[1-3]?[0-9]))|(2\\.(0|([1-9]\\d*))))(\\.(0|\\*|([1-9]\\d*))){0,126}$","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_viewOidIdDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewOidIdOptionsDef"},"exclude":{"description":"Exclude the OID","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"},"value":{"type":"boolean","enum":[false],"$$ref":"#/components/schemas/CommonCommonDefs_booleanFalseDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfViewOidExcludeOptionsDef"}},"required":["id"],"additionalProperties":false}}},"required":["name"],"additionalProperties":false}},"community":{"description":"Configure SNMP community","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"pattern":"^[\\S]+$","type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityNameOptionsDef"},"userLabel":{"description":"Set user label of the SNMP community","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameUserLabelDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameUserLabelOptionsDef"},"view":{"description":"Set name of the SNMP view","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityViewDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityViewOptionsDef"},"authorization":{"description":"Configure access permissions","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["read-only","read-write"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_communityAuthorizationDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfCommunityAuthorizationOptionsDef"}},"required":["name","view"],"additionalProperties":false}},"group":{"description":"Configure an SNMP group","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Name of the SNMP group","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":32,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupNameDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupNameOptionsDef"},"securityLevel":{"description":"Configure security level","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["no-auth-no-priv","auth-no-priv","auth-priv"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupSecurityLevelDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupSecurityLevelOptionsDef"},"view":{"description":"Name of the SNMP view","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":32,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_groupViewDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfGroupViewOptionsDef"}},"required":["name","securityLevel","view"],"additionalProperties":false}},"user":{"description":"Configure an SNMP user","type":"array","uniqueItems":true,"items":{"type":"object","properties":{"name":{"description":"Name of the SNMP user","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":32,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userNameDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserNameOptionsDef"},"auth":{"description":"Configure authentication protocol","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["sha","sha256"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userAuthDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserAuthOptionsDef"},"authPassword":{"description":"Specify authentication protocol password","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userAuthPasswordDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserAuthPasswordOptionsDef"},"priv":{"description":"Configure privacy protocol","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"enum":["aes-cfb-128","aes-256-cfb-128"],"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userPrivDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserPrivOptionsDef"},"privPassword":{"description":"Specify privacy protocol password","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userPrivPasswordDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"},{"properties":{"optionType":{"type":"string","enum":["default"],"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionTypeDef"}},"required":["optionType"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_defaultOptionNoDefaultDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserPrivPasswordOptionsDef"},"group":{"description":"Name of the SNMP group","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":32,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_userGroupDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfUserGroupOptionsDef"}},"required":["name","group"],"additionalProperties":false}},"target":{"description":"Configure SNMP server to receive SNMP traps","type":"array","uniqueItems":true,"items":{"if":{"anyOf":[{"properties":{"vpnId":{"properties":{"optionType":{"const":"global"}},"required":["optionType"]}},"required":["vpnId"]},{"properties":{"ip":{"properties":{"optionType":{"const":"global"}},"required":["optionType"]}},"required":["ip"]},{"properties":{"port":{"properties":{"optionType":{"const":"global"}},"required":["optionType"]}},"required":["port"]}]},"then":{"required":["vpnId","ip","port"]},"type":"object","properties":{"vpnId":{"description":"Set VPN in which SNMP server is located","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":0,"maximum":65530,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetVpnIdDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetVpnIdOptionsDef"},"ip":{"description":"Set IPv4/IPv6 address of SNMP server","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","oneOf":[{"format":"ipv4"},{"format":"ipv6"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetIpDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetIpOptionsDef"},"port":{"description":"Set UDP port number to connect to SNMP server","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minimum":1,"maximum":65535,"type":"integer","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetPortDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetPortOptionsDef"},"userLabel":{"description":"Set user label of the SNMP community","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameUserLabelDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameUserLabelOptionsDef"},"communityName":{"description":"Set name of the SNMP community [Note: Catalyst SD-WAN Manager will encrypt this field before saving. Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]. DEPRECATED. Use userLabel field instead","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetCommunityNameDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetCommunityNameOptionsDef"},"user":{"description":"Set name of the SNMP user","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":32,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetUserDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetUserOptionsDef"},"sourceInterface":{"description":"Source interface for outgoing SNMP traps","type":"object","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"minLength":1,"type":"string","maxLength":32,"pattern":"(^GigabitEthernet|Loopback|TenGigabitEthernet|TwoGigabitEthernet|FortyGigabitEthernet|HundredGigE|Vlan)(([1-9]\\d|\\d)/){0,2}(0|[1-9]\\d*)([:|\\.][1-9]\\d*)?","$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_targetSourceInterfaceDef"}},"required":["optionType","value"],"additionalProperties":false},{"properties":{"optionType":{"type":"string","enum":["variable"],"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeDef"},"value":{"type":"string","pattern":"^\\{\\{[.\\/\\[\\]a-zA-Z0-9_-]+\\}\\}$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_valueDef"},"default":{"minLength":1,"type":"string","maxLength":2048,"$$ref":"#/components/schemas/CommonCommonDefs_defaultDef"},"description":{"minLength":1,"type":"string","maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_descriptionDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/CommonCommonDefs_variableOptionTypeObjectDef"}],"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_oneOfTargetSourceInterfaceOptionsDef"}},"additionalProperties":false}}},"additionalProperties":false}},"required":["data"],"x-metadata":{"supportedDeviceTypes":["asr","c1100","c8000be","csr1000v","ir8100","ir8340","isr","ISRv","ir1101"],"minVManageVersion":"20.18.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanSystemSnmpPostRequest_SchemaPayload"},"examples":{"SNMPParcelGlobalDefault":{"value":{"data":{"shutdown":{"optionType":"global","value":"false"},"contact":{"optionType":"global","value":"wixie.cisco"},"location":{"optionType":"global","value":"SHANGHAI"},"view":[{"name":{"optionType":"global","value":"view1"}}],"group":[{"name":{"optionType":"global","value":"group1"},"securityLevel":{"optionType":"global","value":"auth-priv"},"view":{"optionType":"global","value":"view1"}}],"user":[{"name":{"optionType":"global","value":"user1"},"auth":{"optionType":"global","value":"sha"},"authPassword":{"optionType":"global","value":"$CRYPT_CLUSTER$su56l1Z0Tk4Qc9N7+T/uOg==$sD6b0HLqEdI+RNwsEOoLcQ=="},"priv":{"optionType":"global","value":"aes-256-cfb-128"},"privPassword":{"optionType":"global","value":"$CRYPT_CLUSTER$su56l1Z0Tk4Qc9N7+T/uOg==$sD6b0HLqEdI+RNwsEOoLcQ=="},"group":{"optionType":"global","value":"group1"}},{"name":{"optionType":"global","value":"user88"},"auth":{"optionType":"global","value":"sha"},"authPassword":{"optionType":"global","value":"$CRYPT_CLUSTER$mZc9N6lykLdGejfoLe2FnA==$VD/lwvFTPc8vHBdu7J6ESA=="},"priv":{"optionType":"global","value":"aes-256-cfb-128"},"privPassword":{"optionType":"global","value":"$CRYPT_CLUSTER$mZc9N6lykLdGejfoLe2FnA==$VD/lwvFTPc8vHBdu7J6ESA=="},"group":{"optionType":"global","value":"group1"}},{"name":{"optionType":"global","value":"user-trap"},"auth":{"optionType":"global","value":"sha"},"authPassword":{"optionType":"global","value":"$CRYPT_CLUSTER$pZUhscesCS/2nxog2d1Qkg==$Vs91dCNL5YwlKY8s+mZIyw=="},"priv":{"optionType":"global","value":"aes-cfb-128"},"privPassword":{"optionType":"global","value":"$CRYPT_CLUSTER$pZUhscesCS/2nxog2d1Qkg==$Vs91dCNL5YwlKY8s+mZIyw=="},"group":{"optionType":"global","value":"group1"}}],"target":[{"vpnId":{"optionType":"global","value":0},"ip":{"optionType":"global","value":"10.75.221.156"},"port":{"optionType":"global","value":161},"communityName":{"optionType":"global","value":"$CRYPT_CLUSTER$1CUTGzvVqJQB8c60K6/+JA==$YP4wAuMRXSuz0h1WKe7TWg=="},"user":{"optionType":"global","value":"user-trap"},"source-interface":{"optionType":"global","value":"GigabitEthernet1"}}]},"name":"SNMPParcelGlobalDefault"},"$$ref":"#/components/examples/ProfileparcelSdwanSystemSnmpPostRequest_SNMPParcelGlobalDefault"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"}},"required":["id"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload"},"examples":{"example_1":{"value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"},"$$ref":"#/components/examples/ProfileparcelCommonPostResponse_example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e System \u003e Snmp-write","method":"post","path":"/v1/feature-profile/sdwan/system/{systemId}/snmp"}}