components:
  schemas:
    AggregationSource_v1_4_2_Actions:
      additionalProperties: false
      description: The available actions for this resource.
      properties:
        '#AggregationSource.GenerateSSHIdentityKeyPair':
          $ref: '#/components/schemas/AggregationSource_v1_4_2_GenerateSSHIdentityKeyPair'
        '#AggregationSource.RemoveSSHIdentityKeyPair':
          $ref: '#/components/schemas/AggregationSource_v1_4_2_RemoveSSHIdentityKeyPair'
        Oem:
          $ref: '#/components/schemas/AggregationSource_v1_4_2_OemActions'
          description: The available OEM-specific actions for this resource.
          x-longDescription: This property shall contain the available OEM-specific
            actions for this resource.
      type: object
      x-longDescription: This type shall contain the available actions for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AggregationSource_v1_4_2_AggregationSource:
      additionalProperties: false
      description: The `AggregationSource` schema is used to represent the source
        of information for a subset of the resources provided by a Redfish service.  It
        can be thought of as a provider of information.  As such, most such interfaces
        have requirements to support the gathering of information like address and
        account used to access the information.
      properties:
        '@odata.context':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_context
        '@odata.etag':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_etag
        '@odata.id':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_id
        '@odata.type':
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_type
        Actions:
          $ref: '#/components/schemas/AggregationSource_v1_4_2_Actions'
          description: The available actions for this resource.
          x-longDescription: This property shall contain the available actions for
            this resource.
        AggregationType:
          $ref: '#/components/schemas/AggregationSource_v1_4_2_AggregationType'
          description: The type of aggregation used towards the aggregation source.
          readOnly: false
          x-longDescription: This property shall contain the type of aggregation used
            for the connection method towards the aggregation source.  If this property
            is not present, the value shall be assumed to be `Full`.
          x-versionAdded: v1_2_0
        Description:
          oneOf:
          - $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Description
          - enum:
            - null
          readOnly: true
        HostName:
          description: The URI of the system to be accessed.
          format: uri-reference
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the URI of the system to
            be aggregated.  This property shall not be required when the aggregation
            source is configured to only receive notifications from the aggregated
            system and the `AggregationType` property contains the value `NotificationsOnly`.
        Id:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Id
          readOnly: true
        Links:
          $ref: '#/components/schemas/AggregationSource_v1_4_2_Links'
          description: The links to other resources that are related to this resource.
          x-longDescription: This property shall contain links to resources that are
            related to but are not contained by, or subordinate to, this resource.
        Name:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Name
          readOnly: true
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties that this object contains shall conform to the Redfish
            Specification-described requirements.
        Password:
          description: The password for accessing the aggregation source.  The value
            is `null` in responses.
          nullable: true
          readOnly: false
          type: string
          writeOnly: true
          x-longDescription: This property shall contain a password for accessing
            the aggregation source.  The value shall be `null` in responses.
        SNMP:
          $ref: '#/components/schemas/AggregationSource_v1_4_2_SNMPSettings'
          description: SNMP settings of the aggregation source.
          x-longDescription: This property shall contain the SNMP settings of the
            aggregation source.
          x-versionAdded: v1_1_0
        SSHSettings:
          $ref: '#/components/schemas/AggregationSource_v1_4_2_SSHSettingsType'
          description: Settings for an aggregation source using SSH as part of the
            associated connection method.
          x-longDescription: This property shall contain the settings for an aggregation
            source using SSH as part of the associated connection method.
          x-versionAdded: v1_3_0
        Status:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Status
          description: The status and health of the resource and its subordinate or
            dependent resources.
          x-longDescription: This property shall contain any status or health properties
            of the resource.
          x-versionAdded: v1_3_0
        UserName:
          description: The username for accessing the aggregation source.
          nullable: true
          readOnly: false
          type: string
          x-longDescription: This property shall contain the username for accessing
            the aggregation source.
      required:
      - '@odata.id'
      - '@odata.type'
      - Id
      - Name
      type: object
      x-longDescription: This resource shall represent an aggregation source for a
        Redfish implementation.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AggregationSource_v1_4_2_AggregationType:
      enum:
      - NotificationsOnly
      - Full
      type: string
      x-enumDescriptions:
        Full: Full aggregation according to connection method.
        NotificationsOnly: Only notifications are aggregated.
      x-enumLongDescriptions:
        Full: This value shall indicate that the aggregator is performing full aggregation
          according to the connection method without any limitation such as only receiving
          notifications.
        NotificationsOnly: This value shall indicate that the aggregator is only aggregating
          notifications or events from the aggregation source according to the connection
          method used.  This value shall not be used with connection methods that
          do not include notifications.
    AggregationSource_v1_4_2_GenerateSSHIdentityKeyPair:
      additionalProperties: false
      description: This action generates a new SSH identity key-pair to be used with
        this aggregation source.  The generated public key is stored in the `Key`
        resource referenced by the `PublicIdentityKey` property in `SSHSettings`.  Any
        existing key-pair is deleted and replaced by the new key-pair.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall generate a new SSH identity key-pair to
        be used with this aggregation source.  The service shall store the generated
        public key in the `Key` resource referenced by the `PublicIdentityKey` property
        in `SSHSettings`.  If the aggregation source already has an associated SSH
        identity key-pair, the service shall delete the key-pair and replace it with
        the new key-pair.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
      x-versionAdded: v1_3_0
    AggregationSource_v1_4_2_GenerateSSHIdentityKeyPairRequestBody:
      additionalProperties: false
      description: This action generates a new SSH identity key-pair to be used with
        this aggregation source.  The generated public key is stored in the `Key`
        resource referenced by the `PublicIdentityKey` property in `SSHSettings`.  Any
        existing key-pair is deleted and replaced by the new key-pair.
      properties:
        Curve:
          $ref: http://redfish.dmtf.org/schemas/v1/Key.yaml#/components/schemas/Key_ECDSACurveType
          description: The curve to use with the SSH key if the KeyType parameter
            contains `ECDSA`.
          x-longDescription: This parameter shall contain the curve to use with the
            SSH key.  This parameter shall be required if the `KeyType` parameter
            contains `ECDSA` and shall be rejected for other values.
        KeyLength:
          description: The length of the SSH key, in bits, if the KeyType parameter
            contains `RSA`.
          format: int64
          type: integer
          x-longDescription: This parameter shall contain the length of the SSH key,
            in bits.  This parameter shall be required if the `KeyType` parameter
            contains `RSA` and shall be rejected for other values.
        KeyType:
          $ref: http://redfish.dmtf.org/schemas/v1/Key.yaml#/components/schemas/Key_SSHKeyType
          description: The type of SSH key.
          x-longDescription: This parameter shall contain the type of SSH key.
      required:
      - KeyType
      type: object
      x-longDescription: This action shall generate a new SSH identity key-pair to
        be used with this aggregation source.  The service shall store the generated
        public key in the `Key` resource referenced by the `PublicIdentityKey` property
        in `SSHSettings`.  If the aggregation source already has an associated SSH
        identity key-pair, the service shall delete the key-pair and replace it with
        the new key-pair.
    AggregationSource_v1_4_2_Links:
      additionalProperties: false
      description: The links to other resources that are related to this resource.
      properties:
        ConnectionMethod:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the connection method used to contact this aggregation
            source.
          readOnly: true
          x-longDescription: This property shall a link to a resource of type `ConnectionMethod`
            that represents the method used to connect to the aggregation source.
        Oem:
          $ref: http://redfish.dmtf.org/schemas/v1/Resource.yaml#/components/schemas/Resource_Oem
          description: The OEM extension property.
          x-longDescription: This property shall contain the OEM extensions.  All
            values for properties contained in this object shall conform to the Redfish
            Specification-described requirements.
        ResourcesAccessed:
          description: An array links to the resources added to the service through
            this aggregation source.  It is recommended that this be the minimal number
            of properties needed to find the resources that would be lost when the
            aggregation source is deleted.
          items:
            $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          readOnly: true
          type: array
          x-longDescription: This property shall contain an array of links to the
            resources added to the service through the aggregation source.  It is
            recommended that this be the minimal number of properties needed to find
            the resources that would be lost when the aggregation source is deleted.  For
            example, this could be the pointers to the members of the root-level collections
            or the manager of a BMC.
        ResourcesAccessed@odata.count:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_count
      type: object
      x-longDescription: This Redfish Specification-described type shall contain links
        to resources that are related to but are not contained by, or subordinate
        to, this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AggregationSource_v1_4_2_OemActions:
      additionalProperties: true
      description: The available OEM-specific actions for this resource.
      properties: {}
      type: object
      x-longDescription: This type shall contain the available OEM-specific actions
        for this resource.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AggregationSource_v1_4_2_RemoveSSHIdentityKeyPair:
      additionalProperties: false
      description: This action removes the SSH identity key-pair used with this aggregation
        source.
      properties:
        target:
          description: Link to invoke action
          format: uri-reference
          type: string
        title:
          description: Friendly action name
          type: string
      type: object
      x-longDescription: This action shall remove the private SSH identity key-pair
        used with this aggregation source.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
      x-versionAdded: v1_3_0
    AggregationSource_v1_4_2_RemoveSSHIdentityKeyPairRequestBody:
      additionalProperties: false
      description: This action removes the SSH identity key-pair used with this aggregation
        source.
      properties: {}
      type: object
      x-longDescription: This action shall remove the private SSH identity key-pair
        used with this aggregation source.
    AggregationSource_v1_4_2_SNMPAuthenticationProtocols:
      enum:
      - None
      - CommunityString
      - HMAC_MD5
      - HMAC_SHA96
      - HMAC128_SHA224
      - HMAC192_SHA256
      - HMAC256_SHA384
      - HMAC384_SHA512
      type: string
      x-enumDescriptions:
        CommunityString: Trap community string authentication.
        HMAC128_SHA224: HMAC-128-SHA-224 authentication.
        HMAC192_SHA256: HMAC-192-SHA-256 authentication.
        HMAC256_SHA384: HMAC-256-SHA-384 authentication.
        HMAC384_SHA512: HMAC-384-SHA-512 authentication.
        HMAC_MD5: HMAC-MD5-96 authentication.
        HMAC_SHA96: HMAC-SHA-96 authentication.
        None: No authentication.
      x-enumLongDescriptions:
        CommunityString: This value shall indicate authentication using SNMP community
          strings and the value of `TrapCommunity`.
        HMAC128_SHA224: This value shall indicate authentication for SNMPv3 access
          conforms to the RFC7860-defined usmHMAC128SHA224AuthProtocol.
        HMAC192_SHA256: This value shall indicate authentication for SNMPv3 access
          conforms to the RFC7860-defined usmHMAC192SHA256AuthProtocol.
        HMAC256_SHA384: This value shall indicate authentication for SNMPv3 access
          conforms to the RFC7860-defined usmHMAC256SHA384AuthProtocol.
        HMAC384_SHA512: This value shall indicate authentication for SNMPv3 access
          conforms to the RFC7860-defined usmHMAC384SHA512AuthProtocol.
        HMAC_MD5: This value shall indicate authentication conforms to the RFC3414-defined
          HMAC-MD5-96 authentication protocol.
        HMAC_SHA96: This value shall indicate authentication conforms to the RFC3414-defined
          HMAC-SHA-96 authentication protocol.
        None: This value shall indicate authentication is not required.
    AggregationSource_v1_4_2_SNMPEncryptionProtocols:
      enum:
      - None
      - CBC_DES
      - CFB128_AES128
      - CFB128_AES192
      - CFB128_AES256
      type: string
      x-enumDescriptions:
        CBC_DES: CBC-DES encryption.
        CFB128_AES128: CFB128-AES-128 encryption.
        CFB128_AES192: CFB128-AES-192 encryption.
        CFB128_AES256: CFB128-AES-256 encryption.
        None: No encryption.
      x-enumLongDescriptions:
        CBC_DES: This value shall indicate encryption conforms to the RFC3414-defined
          CBC-DES encryption protocol.
        CFB128_AES128: This value shall indicate encryption conforms to the RFC3826-defined
          CFB128-AES-128 encryption protocol.
        CFB128_AES192: This value shall indicate encryption conforms to the CFB128-AES-192
          encryption protocol, extended from RFC3826.
        CFB128_AES256: This value shall indicate encryption conforms to the CFB128-AES-256
          encryption protocol, extended from RFC3826.
        None: This value shall indicate there is no encryption.
      x-enumVersionAdded:
        CFB128_AES192: v1_4_0
        CFB128_AES256: v1_4_0
    AggregationSource_v1_4_2_SNMPSettings:
      additionalProperties: false
      description: Settings for an SNMP aggregation source.
      properties:
        AuthenticationKey:
          description: The secret authentication key for SNMPv3.
          nullable: true
          pattern: (^[ !#-~]+$)|(^Passphrase:[ ^[ !#-~]+$)|(^Hex:[0-9A-Fa-f]{24,96})|(^\*+$)
          readOnly: false
          type: string
          writeOnly: true
          x-longDescription: This property shall contain the key for SNMPv3 authentication.  The
            value shall be `null` in responses.  This property accepts a passphrase
            or a hex-encoded key.  If the string starts with `Passphrase:`, the remainder
            of the string shall be the passphrase and shall be converted to the key
            as described in the 'Password to Key Algorithm' section of RFC3414.  If
            the string starts with `Hex:`, then the remainder of the string shall
            be the key encoded in hexadecimal notation.  If the string starts with
            neither, the full string shall be a passphrase and shall be converted
            to the key as described in the 'Password to Key Algorithm' section of
            RFC3414.  The passphrase can contain any printable characters except for
            the double quotation mark.
          x-versionAdded: v1_1_0
        AuthenticationKeySet:
          description: Indicates if the `AuthenticationKey` property is set.
          readOnly: true
          type: boolean
          x-longDescription: This property shall contain `true` if a valid value was
            provided for the `AuthenticationKey` property.  Otherwise, the property
            shall contain `false`.
          x-versionAdded: v1_1_0
        AuthenticationProtocol:
          description: The authentication protocol for SNMPv3.
          oneOf:
          - $ref: '#/components/schemas/AggregationSource_v1_4_2_SNMPAuthenticationProtocols'
          - enum:
            - null
          readOnly: false
          x-longDescription: This property shall contain the SNMPv3 authentication
            protocol.
          x-versionAdded: v1_1_0
        EncryptionKey:
          description: The secret authentication key for SNMPv3.
          nullable: true
          pattern: (^[A-Za-z0-9]+$)|(^\*+$)
          readOnly: false
          type: string
          writeOnly: true
          x-longDescription: This property shall contain the key for SNMPv3 encryption.  The
            value shall be `null` in responses.  This property accepts a passphrase
            or a hex-encoded key.  If the string starts with `Passphrase:`, the remainder
            of the string shall be the passphrase and shall be converted to the key
            as described in the 'Password to Key Algorithm' section of RFC3414.  If
            the string starts with `Hex:`, then the remainder of the string shall
            be the key encoded in hexadecimal notation.  If the string starts with
            neither, the full string shall be a passphrase and shall be converted
            to the key as described in the 'Password to Key Algorithm' section of
            RFC3414.  The passphrase can contain any printable characters except for
            the double quotation mark.
          x-versionAdded: v1_1_0
        EncryptionKeySet:
          description: Indicates if the `EncryptionKey` property is set.
          readOnly: true
          type: boolean
          x-longDescription: This property shall contain `true` if a valid value was
            provided for the `EncryptionKey` property.  Otherwise, the property shall
            contain `false`.
          x-versionAdded: v1_1_0
        EncryptionProtocol:
          description: The encryption protocol for SNMPv3.
          oneOf:
          - $ref: '#/components/schemas/AggregationSource_v1_4_2_SNMPEncryptionProtocols'
          - enum:
            - null
          readOnly: false
          x-longDescription: This property shall contain the SNMPv3 encryption protocol.
          x-versionAdded: v1_1_0
        TrapCommunity:
          description: The SNMP trap community string.
          nullable: true
          readOnly: false
          type: string
          writeOnly: true
          x-longDescription: This property shall contain the SNMP trap community string.  The
            value shall be `null` in responses.  Services may provide a common trap
            community if not specified by the client when creating the aggregation
            source.
          x-versionAdded: v1_2_0
      type: object
      x-longDescription: This type shall contain the settings for an SNMP aggregation
        source.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AggregationSource_v1_4_2_SSHSettingsType:
      additionalProperties: false
      description: Settings for an aggregation source using SSH as part of the associated
        connection method.
      properties:
        PresentedPublicHostKey:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the last public host key presented by the remote
            service corresponding to the aggregation source.  A client that trusts
            this public host key can add the public host key to the TrustedPublicHostKeys
            collection to allow SSH communication with the aggregation source.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            `Key` that represents the last public host key presented by the remote
            service corresponding to the aggregation source.  This property shall
            not be present if a public host key has not yet been presented by the
            remote service.
          x-versionAdded: v1_3_0
        PresentedPublicHostKeyTimestamp:
          description: The date and time when the key referenced by the `PresentedPublicHostKey`
            property was last updated.
          format: date-time
          nullable: true
          readOnly: true
          type: string
          x-longDescription: This property shall contain the date and time when the
            key referenced by the `PresentedPublicHostKey` property was last updated.
          x-versionAdded: v1_3_0
        PublicIdentityKey:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the public key that is used with the aggregation
            source when the authentication method is configured to use a public key.  The
            GenerateSSHIdentityKeyPair and RemoveSSHIdentityKeyPair are used to update
            the key for this aggregation source.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource of type
            `Key` that represents the public key that is used with the aggregation
            source when `UserAuthenticationMethod` contains `PublicKey`.  This property
            shall not be present if a key-pair is not available.  The `State` property
            within `Status` shall contain `Disabled` if a key-pair is not available
            and `UserAuthenticationMethod` contains `PublicKey`.
          x-versionAdded: v1_3_0
        TrustedPublicHostKeys:
          $ref: http://redfish.dmtf.org/schemas/v1/odata-v4.yaml#/components/schemas/odata-v4_idRef
          description: A link to the trusted public host keys of the remote service
            corresponding to the aggregation source.  These trusted public host keys
            are used for authentication of the remote service with SSH.  An SSH public
            host key of the remote service can be added to this collection to allow
            for public key-based SSH authentication.
          readOnly: true
          x-longDescription: This property shall contain a link to a resource collection
            of type `KeyCollection` that represents the trusted public host keys of
            the remote service corresponding to the aggregation source.  If the associated
            connection method specifies SSH tunneling, the service shall compare the
            public host key presented by the remote service with members of this collection
            to determine if the remote service can be trusted.  If the remote service
            cannot be trusted, the `State` property within `Status` shall contain
            `Disabled` and the service shall not connect to the remote service.
          x-versionAdded: v1_3_0
        UserAuthenticationMethod:
          description: The client user authentication method.
          oneOf:
          - $ref: '#/components/schemas/AggregationSource_v1_4_2_UserAuthenticationMethod'
          - enum:
            - null
          readOnly: false
          x-longDescription: This property shall contain the client user authentication
            method.
          x-versionAdded: v1_3_0
      type: object
      x-longDescription: This type shall contain the settings for an aggregation source
        using SSH as part of the associated connection method.
      x-patternProperties:
        ^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\.[a-zA-Z_][a-zA-Z0-9_]*$:
          description: This property shall specify a valid odata or Redfish property.
    AggregationSource_v1_4_2_UserAuthenticationMethod:
      enum:
      - PublicKey
      - Password
      type: string
      x-enumDescriptions:
        Password: SSH user authentication with a password.
        PublicKey: SSH user authentication with a public key.
      x-enumLongDescriptions:
        Password: This value shall indicate SSH user authentication with a password
          specified by the `Password` property.
        PublicKey: This value shall indicate SSH user authentication with a public
          key specified by the `PublicIdentityKey` property in `SSHSettings`.
title: '#AggregationSource.v1_4_2.AggregationSource'
x-copyright: Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright
x-language: en
x-owningEntity: DMTF
x-release: '2023.3'
