OBJECT

CalixIntegration

A configuration for a specific Calix SMx endpoint.

link GraphQL Schema definition

  • type CalixIntegration implements IntegrationconfigurableInterface, NoteableInterface, LoggableInterface, AccessloggableInterface {
  • # The ID of the entity.
  • id: Int64Bit!
  • # An ID that uniquely identifies this entity across the whole Sonar system.
  • sonar_unique_id: ID!
  • # The date and time this entity was created.
  • created_at: Datetime!
  • # The last date and time this entity was modified.
  • updated_at: Datetime!
  • # A string that shows the version of this entity. It will be incremented whenever
  • # the entity is modified.
  • _version: String!
  • # Controls if Sonar updates the ICMP device status from SMx alarms
  • alarms_change_device_status: Boolean!
  • # Controls if Sonar should add SMx device alarms to inventory item logs
  • alarms_create_logs: Boolean!
  • # Controls if Sonar updates the inventory item's soft IP address from SMx DHCP
  • # lease alarms.
  • alarms_update_ip_assignment: Boolean!
  • # Disable, pause, then re-enable Calix ONT ports after creating or removing
  • # service. Recommended for deployments using DHCP within SMx.
  • bounce_ports: Boolean!
  • # The Calix policy map name to use when a commercial account becomes delinquent.
  • commercial_delinquency_policy_map: String
  • # The Calix service template name to use when a commercial account becomes
  • # delinquent.
  • commercial_delinquency_service_template: String
  • # Controls whether to turn on synchronization of Calix ONTs and Subscribers, from
  • # Sonar Inventory Items and Accounts.
  • enable_ont_synchronization: Boolean!
  • # The Calix policy map name to use when a government account becomes delinquent.
  • government_delinquency_policy_map: String
  • # The Calix service template name to use when a government account becomes
  • # delinquent.
  • government_delinquency_service_template: String
  • # The Calix policy map name to use when an industrial account becomes delinquent.
  • industrial_delinquency_policy_map: String
  • # The Calix service template name to use when an industrial account becomes
  • # delinquent.
  • industrial_delinquency_service_template: String
  • # The date and time this device was last synchronized.
  • last_synchronized: Datetime
  • # Subscriber organization ID to use for integration
  • org_id: String!
  • # The Calix policy map name to use when a residential account becomes delinquent.
  • residential_delinquency_policy_map: String
  • # The Calix service template name to use when a residential account becomes
  • # delinquent.
  • residential_delinquency_service_template: String
  • # The Calix policy map name to use when a senior citizen account becomes
  • # delinquent.
  • senior_citizen_delinquency_policy_map: String
  • # The Calix service template name to use when a senior citizen account becomes
  • # delinquent.
  • senior_citizen_delinquency_service_template: String
  • # The basic auth credentials to use with SMx, username:password
  • smx_credentials: String!
  • # The URL of the SMx server including the SMx API port, eg. mysmx.org:18443 (SMx
  • # uses 18443 as the default API port)
  • smx_url: String!
  • # The software version of SMx that will be used in integration
  • smx_version: CalixIntegrationVersion!
  • # The status.
  • status: ProvisioningDeviceStatus
  • # A message describing what caused the current status of this device.
  • status_message: String
  • # The ID of the account custom field which holds the SMx subscriber ID of the
  • # account.
  • subscriber_custom_field_id: Int64Bit
  • # Whether or not a synchronization request is queued.
  • synchronization_queued: Boolean!
  • # The date/time that synchronization started.
  • synchronization_start: Datetime
  • # An entity which maps an inventory model field to a vendor specific integration
  • # field type (ie serial number)
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # integration_field_type: The vendor specific type for field.
  • # integrationconfigurable_id: The ID of the configuration entity
  • # which owns this mapping.
  • # integrationconfigurable_type: The type of the configuration
  • # entity which owns this mapping.
  • # inventory_model_field_id: The ID of an `InventoryModelField`.
  • # inventory_model_id: The ID of an `InventoryModel`.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • integration_field_mappings(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • integration_field_type: IntegrationFieldType,
  • integrationconfigurable_id: Int64Bit,
  • integrationconfigurable_type: String,
  • inventory_model_field_id: Int64Bit,
  • inventory_model_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IntegrationFieldMappingConnection!
  • # An entity which maps a service to a vendor specific service name
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # integrationconfigurable_id: The ID of the configuration entity
  • # which owns this mapping.
  • # integrationconfigurable_type: The type of the configuration
  • # entity which owns this mapping.
  • # policy_map: Policy Map.
  • # service_id: The ID of a Service.
  • # service_template_name: The service name in vendor system this
  • # mapping refers to.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • integration_service_mappings(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • integrationconfigurable_id: Int64Bit,
  • integrationconfigurable_type: String,
  • policy_map: String,
  • service_id: Int64Bit,
  • service_template_name: String,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): IntegrationServiceMappingConnection!
  • # A note.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # message: The message.
  • # noteable_id: The ID of the entity that owns this note.
  • # noteable_type: The type of entity that owns this note.
  • # priority: The priority of this item.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • notes(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • message: Text,
  • noteable_id: Int64Bit,
  • noteable_type: NoteableType,
  • priority: NotePriority,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): NoteConnection!
  • # A log entry.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # current: Current data.
  • # legacy: Whether or not this log was transferred from a Sonar v1
  • # instance. If so, the formatting will not match current version logs.
  • # legacy_title: A title which is only populated on logs that were
  • # imported from Sonar v1.
  • # level: The severity level.
  • # loggable_id: The ID of the entity that this log is attached to.
  • # loggable_type: The type of entity that this log is attached to.
  • # logged_entity_id: The entity ID that triggered the log.
  • # logged_entity_type: The entity that triggered the log.
  • # message: The message.
  • # previous: Previous data.
  • # relation_data: Data from objects related to this change.
  • # type: The type.
  • # user_id: The ID of a User.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • current: Text,
  • legacy: Boolean,
  • legacy_title: String,
  • level: LogLevel,
  • loggable_id: Int64Bit,
  • loggable_type: String,
  • logged_entity_id: Int64Bit,
  • logged_entity_type: String,
  • message: Text,
  • previous: Text,
  • relation_data: Text,
  • type: LogType,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): LogConnection!
  • # An access log history on an entity.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # access_datetime: The date and time that this entity was
  • # accessed.
  • # accessloggable_id: The ID of the entity that this access log
  • # belongs to.
  • # accessloggable_type: The entity that this access log belongs
  • # to.
  • # entity_id: The ID of the entity that this access log belongs
  • # to.
  • # entity_name: The entity that this access log belongs to.
  • # user_id: The ID of the user that accessed this entity.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • access_logs(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • access_datetime: Datetime,
  • accessloggable_id: Int64Bit,
  • accessloggable_type: String,
  • entity_id: Int64Bit,
  • entity_name: String,
  • user_id: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccessLogConnection!
  • # Holds information for provisioning service on Calix devices.
  • #
  • # Arguments
  • # id: The ID of the entity.
  • # sonar_unique_id: An ID that uniquely identifies this entity
  • # across the whole Sonar system.
  • # created_at: The date and time this entity was created.
  • # updated_at: The last date and time this entity was modified.
  • # _version: A string that shows the version of this entity. It
  • # will be incremented whenever the entity is modified.
  • # account_service_id: The ID of an AccountService.
  • # calix_integration_id: Calix Inegartion ID.
  • # custom_json: Custom JSON.
  • # cvlan: C-VLAN.
  • # global_vlan: Global VLAN.
  • # ont_port_id: ONT Port ID.
  • # policy_map: Policy Map.
  • # use_custom_json: Use Custom JSON.
  • # vlan: VLAN.
  • # paginator: Provides the ability to paginate through results.
  • # sorter: Provides the ability to sort results.
  • # search: Complex search parameters.
  • # general_search: Search across all string fields with partial
  • # matching.
  • # aggregation: Provides the ability to return aggregated
  • # mathematical data about your results.
  • # reverse_relation_filters: Reverse relation filters allow you to
  • # filter the result of a relation, and use that filter to affect the returned root
  • # elements.
  • account_calix_service_details(
  • id: Int64Bit,
  • sonar_unique_id: ID,
  • created_at: Datetime,
  • updated_at: Datetime,
  • _version: String,
  • account_service_id: Int64Bit,
  • calix_integration_id: Int64Bit,
  • custom_json: String,
  • cvlan: Int,
  • global_vlan: String,
  • ont_port_id: String,
  • policy_map: String,
  • use_custom_json: Boolean,
  • vlan: Int64Bit,
  • paginator: Paginator,
  • sorter: [Sorter],
  • search: [Search],
  • general_search: String,
  • aggregation: [Aggregator],
  • reverse_relation_filters: [ReverseRelationFilter]
  • ): AccountCalixServiceDetailConnection!
  • }