Get All Chassis Syslog Setting - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get All Chassis Syslog Setting","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"deprecated":false,"description":"**Get all syslog settings policies for a particular chassis platform settings policy.**","operationId":"getAllChassisSyslogSetting","parameters":[{"description":"UUID of the ticket for tracking the configuration changes.","in":"header","name":"ticket-id","required":false,"schema":{"type":"string"}},{"description":"The container id under which this specific resource is contained.","in":"path","name":"containerUUID","required":true,"schema":{"type":"string"}},{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsetting ( Example payload for GET on ChassisSyslogSetting Policy )":{"value":{"items":[{"id":"SyslogSettingUUID","syslogConsole":{"isSyslogConsoleEnabled":"true","severity":"EMERGENCIES"},"syslogFile":{"fileSizeLimit":"4194304","isSyslogFileEnabled":"true","severity":"CRITICAL"},"syslogMonitor":{"isSyslogMonitorEnabled":"true","severity":"CRITICAL"},"syslogRemoteClients":[{"forwardingFacility":"LOCAL7","hostname":"192.168.123.42","isClientEnabled":"true","severity":"ERRORS"},{"forwardingFacility":"LOCAL7","hostname":"192.168.32.123","isClientEnabled":"true","severity":"WARNINGS"},{"forwardingFacility":"LOCAL7","hostname":"192.168.23.52","isClientEnabled":"true","severity":"CRITICAL"}],"syslogSource":{"isAuditsEnabled":"true","isEventsEnabled":"true","isFaultsEnabled":"true"},"type":"SyslogSetting"}],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/syslogsettings?offset=0&limit=25"},"paging":{"count":1,"limit":25,"offset":0,"pages":1}}},"Example 2 : GETALL /api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsetting ( Example payload for GET on ChassisSyslogSetting Policy )":{"value":{"items":[{"id":"SyslogSettingUUID","syslogConsole":{"isSyslogConsoleEnabled":"true","severity":"EMERGENCIES"},"syslogFile":{"fileSizeLimit":"4194304","isSyslogFileEnabled":"true","severity":"CRITICAL"},"syslogMonitor":{"isSyslogMonitorEnabled":"true","severity":"CRITICAL"},"syslogRemoteClients":[{"forwardingFacility":"LOCAL7","hostname":"192.168.123.42","isClientEnabled":"true","severity":"ERRORS"},{"forwardingFacility":"LOCAL7","hostname":"192.168.32.123","isClientEnabled":"true","severity":"WARNINGS"},{"forwardingFacility":"LOCAL7","hostname":"192.168.23.52","isClientEnabled":"true","severity":"CRITICAL"}],"syslogSource":{"isAuditsEnabled":"true","isEventsEnabled":"true","isFaultsEnabled":"true"},"type":"SyslogSetting"}],"links":{"self":"\u003cfmc_url\u003e/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/policy/chassisplatformsettingspolicies/0050568A-CCB0-0ed3-0000-193273528368/syslogsettings?offset=0&limit=25"},"paging":{"count":1,"limit":25,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Description of Chassis Syslog Settings policy","properties":{"description":{"type":"string"},"id":{"description":"Id of the object","type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","description":"Defines read only details about the object - whether it is system defined, last user who modified the object etc.","properties":{"domain":{"description":"Defines the domains this instance belongs to (if applicable).","type":"object","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"isLocked":{"type":"boolean"},"lastUser":{"description":"The last user who modified this instance.","type":"object","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"description":"Details regarding the read only status of this instance","type":"object","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"description":"The last updated timestamp.","format":"int32","type":"integer"}},"$$ref":"#/components/schemas/Metadata"},"name":{"description":"name of Chassis Syslog settings object, this value is always SyslogSettingObject","type":"string"},"syslogConsole":{"description":"Send syslog to console","type":"object","properties":{"isSyslogConsoleEnabled":{"description":"Enable Status of Syslog Console","type":"boolean"},"severity":{"description":"Severity of logs that should be captured. Syslog messages of selected level and higher severity levels will be captured.","enum":["EMERGENCIES","ALERTS","CRITICAL"],"type":"string"}},"$$ref":"#/components/schemas/ChassisSyslogConsole"},"syslogFile":{"description":"Send syslog to file","type":"object","properties":{"fileName":{"type":"string"},"fileSizeLimit":{"description":"Maximum allowed size limit of the syslog file to be stored is 4096 - 4194304 (bytes)","format":"int32","type":"integer"},"isSyslogFileEnabled":{"description":"Enable Status of Syslog File","type":"boolean"},"severity":{"description":"Severity of logs that should be captured. Syslog messages of selected level and higher severity levels will be captured.","enum":["EMERGENCIES","ALERTS","CRITICAL","ERRORS","WARNINGS","NOTIFICATIONS","INFORMATION","DEBUGGING"],"type":"string"}},"$$ref":"#/components/schemas/ChassisSyslogFile"},"syslogMonitor":{"description":"Send Syslog to SSH session","type":"object","properties":{"isSyslogMonitorEnabled":{"description":"Enable Status of Syslog Monitor","type":"boolean"},"severity":{"description":"Severity of logs that should be captured. Syslog messages of selected level and higher severity levels will be captured.","enum":["EMERGENCIES","ALERTS","CRITICAL","ERRORS","WARNINGS","NOTIFICATIONS","INFORMATION","DEBUGGING"],"type":"string"}},"$$ref":"#/components/schemas/ChassisSyslogMonitor"},"syslogRemoteClients":{"description":"Remote destinations to send syslog to","items":{"type":"object","description":"Chassis Syslog Remote Clients Settings","properties":{"forwardingFacility":{"description":"System log facility for remote syslog server to use as a basis to file messages","enum":["LOCAL0","LOCAL1","LOCAL2","LOCAL3","LOCAL4","LOCAL5","LOCAL6","LOCAL7"],"type":"string"},"hostname":{"description":"Hostname / IP Address of remote server","type":"string"},"isClientEnabled":{"description":"Enable Status of Syslog Console","type":"boolean"},"severity":{"description":"Severity of logs that should be captured. Syslog messages of selected level and higher severity levels will be captured.","enum":["EMERGENCIES","ALERTS","CRITICAL","ERRORS","WARNINGS","NOTIFICATIONS","INFORMATION","DEBUGGING"],"type":"string"}},"$$ref":"#/components/schemas/ChassisSyslogRemoteClient"},"type":"array"},"syslogSource":{"type":"object","description":"Chassis Syslog Sources","properties":{"isAuditsEnabled":{"description":"Enable state of logging Audits","type":"boolean"},"isEventsEnabled":{"description":"Enable state of logging events","type":"boolean"},"isFaultsEnabled":{"description":"Enable state of logging faults","type":"boolean"}},"$$ref":"#/components/schemas/ChassisSyslogSource"},"type":{"description":"Type of the Chassis Syslog settings policy; this value is always SyslogSetting.","type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/ChassisSyslogSetting"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/ChassisSyslogSettingListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Policy"],"__originalOperationId":"getAllChassisSyslogSetting","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/policy/chassisplatformsettingspolicies/{containerUUID}/syslogsettings"}}