Cloud Services Management V1.1.0 Operation Guide

5.3.3 Contracts

Among the commands for contract operations, the following three subcommands use XML:

• fscsm_contract create (Addition of contracts)

• fscsm_contract modify (Modification of contracts)

• fscsm_contract export (Export of contracts)

The format of the XML file corresponding to the command above is explained below.

The elements of the XML must be specified using the following hierarchical structure:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<contracts>
    <contract>
        <comment>Comment</comment>
        <contractId>Contract ID</contractId>
        <contractName>Contract Name</contractName>
        <contractNo>Contract Number</contractNo>
        <contractPeriod>Contract Period</contractPeriod>
        <contractorContact>Contractor Contact Information</contractorContact>
        <contractorName>Contractor</contractorName>
        <maintenanceId>Maintenance Service ID</maintenanceId>
        <vendorId>Vendor ID</vendorId>
        <vendorPortalId>Vendor Portal ID</vendorPortalId>
        <usePermission>License_Agreement</usePermission>
    </contract> 
</contracts>

Element (Element Name or Element Name and Attribute)	Required or Displayed			Specifiable Values During Addition or Modification
	Addition	Modification	Output
Description (comment)	No	No	Yes	Specify a character string containing 0 to 256 characters.
Contract ID (contractId)	Yes	Yes *1	Yes	Specify a character string beginning with a lower-case alphanumeric character and containing 1 to 32 alphanumeric characters, underscores ("_"), hyphens ("-"), and periods ("."). The ID must not overlap with the IDs of other contracts. Specify a unique value.
Contract Name (contractName)	Yes	Yes	Yes	Specify a character string containing 1 to 64 characters.
Contract Number (contractNo)	No	No	Yes	Specify a character string containing 0 to 64 characters.
Contract Period (contractPeriod)	No	No	Yes	Specify a character string containing 0 to 256 characters.
Contractor Contact Information (contractorContact)	No	No	Yes	Specify a phone number or an email address. Specify a character string containing 0 to 256 characters.
Contractor (contractorName)	No	No	Yes	Specify a character string containing 0 to 64 characters.
Maintenance Service ID (maintenanceId)	No	No	Yes	Specify a character string containing 0 to 64 characters. However, this element cannot be specified when type is set to "ror", "physical", or "vmware" in the cloud vendor definition file.
Vendor ID (vendorId)	Yes	Yes *1	Yes	Specify the vendor ID contained in the cloud vendor information.
Vendor Portal ID (vendorPortalId)	No	No	Yes	Specify a character string containing 0 to 64 characters. However, this element cannot be specified when type is set to "ror", "physical", or "vmware" in the cloud vendor definition file.
User Agreement (usePermission)	No	No *2	Yes	Specify a character string containing 0 to 1024 characters.

The meanings of the entries listed under "Required or Displayed" are as follows:

Yes: Entry is required, or element is output.

No: Can be omitted.

-: Specification is not permitted, or element is not output.

*1: Modification is not possible.

*2: When the value is omitted during modification, the value from before modification is deleted.