OBJECT

Policy

link GraphQL Schema definition

  • type Policy {
  • # Retrieve the specified object from the current open domain. Domain must first be
  • # open/cached by openDomain query. Setting dataType to "PolicyDomainData" returns
  • # full domain object in result for lists of data (roles, etc)
  • #
  • # Arguments
  • # input:
  • cachedDomainObject(input: DomainObjectInput!): PolicyDataQueryOutput
  • # Cancel the current enforce/verify operation underway for the calling
  • # client+hostname.
  • #
  • # Arguments
  • # input:
  • cancelEnforceVerify(input: EnforceVerifyResultInput!): EnforceQueryOutput
  • # Removes domain from in memory cache. If domain is modified, will return error
  • # unless discardChanges = true to protect loss of data. If domain is modified,
  • # call saveDomain mutation first.
  • #
  • # Arguments
  • # input:
  • closeDomain(input: DomainCloseInput!): PolicyDataQueryOutput
  • # Return policy domain class of service. By default, caches domain in memory for
  • # calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • cos(input: CosDataInput!): CosQueryOutput
  • # Return policy domain class of service list. By default, caches domain in memory
  • # for calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • cosList(input: PolicyDomainListDataInput!): CosListQueryOutput
  • # Return the domain that the specified device belongs to. If policy is not
  • # supported returns "Policy Unsupported". If device does not exist in XMC or is
  • # not in a domain returns null.
  • #
  • # Arguments
  • # ip:
  • domainNameByIp(ip: String!): String
  • # Return all defined domains, if withDevicesOnly = true, omits domains that have
  • # no devices.
  • #
  • # Arguments
  • # withDevicesOnly:
  • domainNames(withDevicesOnly: Boolean): [String]
  • # Return the results of the most recent enforce or verify. This includes 'In
  • # Progress' stats if the operation is not complete. If the operation IS complete,
  • # the results can only be retrieved once. Requires valid operationId from
  • # enforce/verify call.
  • #
  • # Arguments
  • # input:
  • enforceVerifyDomainResult(
  • input: EnforceVerifyResultInput!
  • ): EnforceQueryOutput
  • # Return policy domain network resource. By default, caches domain in memory for
  • # calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • networkResource(input: NetworkRescDataInput!): NetworkRescQueryOutput
  • # Return policy domain network resource topology. By default, caches domain in
  • # memory for calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • networkResourceTopo(input: NetworkRescDataInput!): NetworkRescTopoQueryOutput
  • # Return policy domain network resource topology list. By default, caches domain
  • # in memory for calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • networkResourceTopos(input: PolicyDomainListDataInput!): NetworkRescTopoListQueryOutput
  • # Return policy domain network resource list. By default, caches domain in memory
  • # for calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • networkResources(input: PolicyDomainListDataInput!): NetworkRescListQueryOutput
  • # Opens & returns specified policy domain. This caches the domain in memory
  • # allowing for data object modifications. After configuration, changes must be
  • # persisted by calling the saveDomain mutation.
  • #
  • # Arguments
  • # input:
  • openDomain(input: DomainOpenInput!): PolicyDataQueryOutput
  • # Return policy domain PVI Island. By default, caches domain in memory for calling
  • # client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • pviIsland(input: PviIslandDataInput!): PviIslandQueryOutput
  • # Return policy domain PVI Island list. By default, caches domain in memory for
  • # calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • pviIslands(input: PolicyDomainListDataInput!): PviIslandListQueryOutput
  • # Return policy domain PVI Service ID. By default, caches domain in memory for
  • # calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • pviNsi(input: PviNsiDataInput!): NsiPviQueryOutput
  • # Return policy domain PVI VLAN. By default, caches domain in memory for calling
  • # client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • pviVlan(input: PviVlanDataInput!): VlanQueryOutput
  • # Return policy domain PVI Service ID list. By default, caches domain in memory
  • # for calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • pviVlans(input: PolicyDomainListDataInput!): PolicyDataQueryOutput
  • # Return policy domain role. By default, caches domain in memory for calling
  • # client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • role(input: RoleDataInput!): RoleQueryOutput
  • # Return policy domain role list. By default, caches domain in memory for calling
  • # client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • roles(input: PolicyDomainListDataInput!): RoleListQueryOutput
  • # Return policy domain rule from a service. By default, caches domain in memory
  • # for calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • rule(input: RuleDataInput!): RuleQueryOutput
  • # Return all policy domain rules from a service. By default, caches domain in
  • # memory for calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • rules(input: RuleListDataInput!): RuleListQueryOutput
  • # Return policy domain service. By default, caches domain in memory for calling
  • # client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • service(input: ServiceDataInput!): ServiceQueryOutput
  • # Return policy domain service list. By default, caches domain in memory for
  • # calling client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • services(input: PolicyDomainListDataInput!): ServiceListQueryOutput
  • # Start verify of devices against config in domain, uses cached version if
  • # present, db if not. Request status/result via query to enforceVerifyResult
  • #
  • # Arguments
  • # input:
  • verifyDomain(input: VerifyDomainInput!): EnforceQueryOutput
  • # Return policy domain VLAN. By default, caches domain in memory for calling
  • # client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • vlan(input: VlanDataInput!): VlanQueryOutput
  • # Return policy domain VLAN list. By default, caches domain in memory for calling
  • # client+hostname if not cached/open.
  • #
  • # Arguments
  • # input:
  • vlans(input: PolicyDomainListDataInput!): VlanListQueryOutput
  • # Return the defiend application group well known values/ids, which can be used as
  • # inputs for rule mutations
  • wellKnownAppGroups: [Json]
  • # Return the values associated to the well known values, which can be used as
  • # inputs for rule mutations
  • #
  • # Arguments
  • # trafDescType:
  • # ruleType: Optional device type. Currently only matters for C5
  • # devices + ICMPv6
  • wellKnowns(
  • trafDescType: TrafDescTypeInput!,
  • ruleType: RuleTypeEnumInput
  • ): [Json]
  • }